diff --git a/README.md b/README.md index 172809f..01cfb82 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -# Calctex -An [Obsidian](https://obsidian.md/) plugin that automatically calculates the solution for your LaTeX formulas. +# Docxer +An [Obsidian](https://obsidian.md/) plugin that allows you to import and convert .docx files into markdown files. This plugin also adds a preview for .docx files. ## Usage -To calculate the solution for a formula, simply add a `=` sign after the formula and the solution will be automatically calculated and displayed. If you want to write the solution to the document, just click on the solution or press the `Tab` key. +1. Add a .docx file to your vault. +2. Open the file in Obsidian. +3. Click the "Convert" button in the top right corner of the editor to convert the file to markdown. + +## Screenshots +![Docx Preview](screenshots/docx-preview.png) +![Converted File](screenshots/converted-file.png) +![Settings](screenshots/settings.png) ## Installation -Download it from the community plugins list +~~Download it from the community plugins list~~ (coming soon) OR 1. Download the files from the latest release from the releases page. -2. Put the files into `/.obsidian/plugins/calctex`. +2. Put the files into `/.obsidian/plugins/docxer`. 3. Reload Obsidian and enable the plugin in the settings. 4. Enjoy! diff --git a/manifest.json b/manifest.json index 7b4fda1..18c5a70 100644 --- a/manifest.json +++ b/manifest.json @@ -1,9 +1,9 @@ { "id": "docxer", "name": "Docxer", - "version": "0.0.1", + "version": "1.0.0", "minAppVersion": "0.15.0", - "description": "Import Word files into obsidian. Converts .docx files to .md files.", + "description": "Import Word files into obsidian. Adds a preview mode for .docx files and the ability to convert them to markdown (.md) files.", "author": "Developer-Mike", "authorUrl": "https://github.com/Developer-Mike", "isDesktopOnly": false diff --git a/screenshots/converted-file.png b/screenshots/converted-file.png new file mode 100644 index 0000000..e1de1bb Binary files /dev/null and b/screenshots/converted-file.png differ diff --git a/screenshots/docx-preview.png b/screenshots/docx-preview.png new file mode 100644 index 0000000..3900a28 Binary files /dev/null and b/screenshots/docx-preview.png differ diff --git a/screenshots/settings.png b/screenshots/settings.png new file mode 100644 index 0000000..0e6a3ce Binary files /dev/null and b/screenshots/settings.png differ