fix: add readme

README.md

@@ -1,63 +1,56 @@
 # Ziyo
 
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
+<p align="center">
 
-✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
+![Ziyo](assets/ziyo-search-ui.png)
 
+</p>
 
-## Start the app
+Ziyo (Japanese: ジヨ *ziyo*) a stupidly simple online Kanji dictionary and search engine.
 
-To start the development server run `nx serve ziyo`. Open your browser and navigate to http://localhost:4200/. Happy coding!
+With Ziyo, you can search across thousands of kanji and view its readings, meanings, variations, and example sentences. It is targeted for Japanese learner who wants to do a quick but deep search about a kanji.
 
+### Search a kanji by:
 
-## Generate code
+- Onyomi reading (Kana/Latin)
+- Kunyomi reading (Kana/Latin)
+- Chinese Mandarin reading (Pinyin readings)
+- Korean reading (Hangul/Latin - Hanja readings)
+- Meanings (in English)
 
-If you happen to use Nx plugins, you can leverage code generators that might come with it.
+## Features
+- Search and browse Kanji characters.
+- Detailed information for each Kanji, including meanings, readings, and examples.
+- User-friendly interface. With romaji support for those who are not familiar with kana.
+- Opengraph image for quick sharing on social media.
 
-Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list <plugin-name>` to see what generators are available.
+![Ziyo](assets/ziyo-kanji-og.png)
+*Open Graph image for Kanji page*
 
-Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators).
+## Technologies used
 
-## Running tasks
+- Next.js for frontend
+- Hono.js for backend
+- Tailwind + Shadcn UI
+- Typesense (search engine)
+- Nx Monorepo
+- pnpm
 
-To execute tasks with Nx use the following syntax:
+## Development
 
-```
-nx <target> <project> <...options>
-```
-
-You can also run multiple targets:
-
-```
-nx run-many -t <target1> <target2>
-```
+```bash
+# Clone the repository
+git clone https://github.com/masnormen/ziyo.git
+cd ziyo
 
-..or add `-p` to filter specific projects
+# Install dependencies
+pnpm install
 
+# Start the development server for both frontend and backend
+pnpm dev
 ```
-nx run-many -t <target1> <target2> -p <proj1> <proj2>
-```
-
-Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks).
-
-## Want better Editor Integration?
-
-Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
-
-## Ready to deploy?
-
-Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed.
-
-## Set up CI!
-
-Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
-
-- [Set up remote caching](https://nx.dev/core-features/share-your-cache)
-- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
-- [Learn more how to setup CI](https://nx.dev/recipes/ci)
 
-## Connect with us!
+Open your browser and go to `http://localhost:3000` to view the frontend application.
 
-- [Join the community](https://nx.dev/community)
-- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
-- [Follow us on Twitter](https://twitter.com/nxdevtools)
+## License
+This project is licensed under the MIT License.