chore(release): release 0.1.0

README.md

@@ -1,3 +1,55 @@
-# Zekrom
-Desktop markdown editor built in with Tauri + React (Typescript)
+# Zekrom (ゼクロム / Zekuromu)
+
+This is a simple desktop application for viewing and editing Markdown files. It was built with Tauri, a framework that enables the creation of native desktop applications using web technoligies such as React, Typescript and Vite
+
+## Features 
+
+- [ ] - View and edit Markdown files
+- [ ] - Syntax highlighting
+- [ ] - Live preview of content
+- [ ] - Save files locally
+- [ ] - Dark, light and solarized themes
+- [ ] - Dark, light and solarized themes
+- [ ] - VIM mode
+
+## Installation
+
+To install this app on your desktop, follow these steps:
+
+1. Download the latest version of the app from the Github releases page.
+2. Install the app on your desktop by running the downloaded installer file.
+3. Once the installation is complete, launch the app to start writing markdown
+
+## Contributing
+
+If you'd like to contribute to the project, please follow these steps:
+1. Fork the repository
+2. Create a new branch for your feature: git checkout -b feature-name
+3. Make your changes
+4. Test your changes
+5. Commit your changes: git commit -m 'Add some feature'
+6. Push to the branch: git push origin feature-name
+7. Create a pull request
+
+## Todo
+- [ ] - `Global`: Save cursor position when swith to preview
+- [ ] - `Settings`: Load the theme (vscode)
+- [ ] - `Global`: Save local user session
+- [ ] - *`Feature`*: Add keyboard typing showcase
+- [ ] - *`Feature`*: Color marker
+- [ ] - *`Feature`*: Change way to manage data (theme, settings, e.t.c) / kill the `Prop drilling`
+- [ ] - *`Fix`*: Fix markdown monaco highilight
+- [ ] - *`Global`*: Read data from sample.md not fron const INITIAL_SAMPLE 
+![zekrom pokemon](https://img.pokemondb.net/artwork/vector/large/zekrom.png)
+
+## Contact
+
+If you have any questions or feedback, feel free to contact me at [email protected].
+
+Thank you for using this app! I hope you find it helpful for your Markdown editing needs
+
+
+
+
+