update readme

Author: mProjectsCode

README.md

@@ -1,38 +1,22 @@
-# Lemons Plugin Template
+# Obsidian Shiki Plugin
 
-## Setup
+This plugin integrates [shiki](https://shiki.style/) into Obsidian, providing better syntax highlighting for over 250 languages.
 
-This uses [bun](https://bun.sh/), not node. So you need that installed. If you are on windows use WSL, if that does not work... good luck.
+This plugin works in reading mode and in live preview mode, as long as your cursor is not inside the code block.
 
-Things to change Checklist:
+## License
 
--   [ ] `manifest.json`
--   [ ] `package.json`
--   [ ] `versions.json`
--   [ ] `automation/config.js`
--   [ ] `.github/workflows/release.yml`
--   [ ] rename `exampleVault/.obsidian/lemons-plugin-template`
+[MIT](https://github.com/mProjectsCode/obsidian-shiki-plugin/blob/master/LICENSE)
 
-If and **only if** you completed these steps, you can run `bun install` and `bun run dev` to start your plugin jorney.
+## Installation
 
-## Scripts Explained
+### BRAT
 
--   `dev` - build into the example vault with hot reload
--   `build` - build for release
--   `tsc` - run type checker
--   `test` - run your tests
--   `test:log` - run your tests with console output enabled
--   `format` - format your code
--   `format:check` - check the formatting of your code
--   `lint` - lint your code
--   `lint:fix` - lint your code and fix auto fixable mistakes
--   `check` - check for formatting, linting, type errors and run the tests
--   `check:fix` - fix formatting and linting errors, check for type errors and run the tests
--   `release` - run the script to release a new version
+1. Install and enable the `BRAT` plugin
+2. Run the `BRAT: Plugins: Add a beta plugin for testing` command
+3. Enter `https://github.com/mProjectsCode/obsidian-shiki-plugin` into the text field
+4. Click on `Add Pluign`
 
-## References
+## Credits
 
--   Sample plugin repo: https://github.com/obsidianmd/obsidian-sample-plugin
--   Obsidian help: https://help.obsidian.md/Home
--   Obsidian docs: https://docs.obsidian.md/Home
--   Obsidian API: https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts
+This plugin uses the [shiki](https://shiki.style/) library and parts of the Dracula VSCode theme for syntax highlighting.