chore: add and update readme (#6)

* chore: add cover

* chore: add nvmrc

* chore: update readme

.nvmrc

@@ -0,0 +1 @@
+v18

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing
+
+We're so excited you're interested in helping with Oku! We are happy to help you get started, even if you don't have any previous open-source experience :blush:
+
+## New to Open Source?
+
+1. Take a look at [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+## Where to ask Questions?
+
+1. Check our [Github Issues](https://github.com/oku-ui/pergel/issues) to see if someone has already answered your question.
+2. Join our community on [Discord](https://chat.productdevbook.com) and feel free to ask us your questions
+
+
+### Prerequisites
+-   [Min Nodejs 18] & [PNPM >= 8.8.0](https://pnpm.io) installed 
+-   IDE: [VSCode](https://code.visualstudio.com/download)(recommended) or equivalent IDE
+
+Note: If you have [nvm](https://github.com/nvm-sh/nvm), you can run `nvm i` to install the required version.
+
+### VScode Extensions
+
+-  [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+### Project Setup
+
+1. Fork the [oku-ui](https://github.com/oku-ui/pergel) repository
+2. Install the project dependencies  
+   `pnpm install`
+
+### Scripts
+
+```shell
+pnpm lint # Run ESLint
+pnpm lint:fix # Run ESLint and fix errors
+
+pnpm test # Run tests
+pnpm test:watch # Run tests in watch mode
+pnpm test testfilename # Run a specific test file name
+``` 
+
+## Testing
+
+1. We use [Vitest](https://vitest.dev/) for testing
+2. To run the tests  
+   `pnpm test`
+3. Watch mode  
+   `pnpm test:watch`
+4. To run a specific test file name  
+   `pnpm test testfilename`
+
+## ESLint
+1. To run the linter  
+   `pnpm lint`
+2. All linting errors will be automatically fixed on commit
+   `pnpm lint:fix`
+
+
+## Pull Request
+
+1. Before submitting a pull request make sure all tests have passed
+2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
+3. Make sure the PR title follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification
+
+## Oku Community
+
+Oku is made possible by a passionate team and a strong community of developers. If you have any questions or would like to get more involved in the Oku community you can check out:
+
+-   [Github Issues](https://github.com/oku-ui/pergel/issues)
+-   [Discord](https://chat.productdevbook.com)
+-   [Twitter](https://twitter.com/oku_ui)

README.md

@@ -1,2 +1,28 @@
-# pergel
+![Pergel Cover](./.github/assets/pergel-cover.jpg)
+
+# Pergel
 Full Stack Nuxt Application. It contains the necessary toolkits for a software developer and a fast, clean, tested toolkit.
+
+# Contributing
+
+Please read our [contributing guide](https://github.com/oku-ui/pergel/blob/master/CONTRIBUTING.md)
+
+
+## Community
+
+- [Discord](https://chat.productdevbook.com) - To get involved with the Oku community, ask questions and share tips.
+- [Twitter](https://twitter.com/oku_ui) - To receive updates, announcements, blog posts, and general Oku tips.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/productdevbook/static/sponsors.svg">
+    <img alt="sponsors" src='https://cdn.jsdelivr.net/gh/productdevbook/static/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+Licensed under the MIT License, Copyright © 2023-present [productdevbook](https://twitter.com/productdevbook).
+
+See [LICENSE](./LICENSE) for more information.