diff --git a/README.md b/README.md index 49c9086..848ed76 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,71 @@ Devty This tool is inspired from DevUtils

+
+
+ + + +
+ + + +
+ + + +
+ Devty Homepage Screenshot + + ## How does it works? Devty doesn't have any backend, it uses browser APIs and libraries to provide tools. For example the [`Hash Generator`](https://devty.vercel.app/hash_generator) tool uses [`Google's CryptoJS Library`](https://www.npmjs.com/package/crypto-js) to generate different hash of a given string directly in your browser **Devty doesn't have any backend and is a frontend specific app. No data is ever sent to the backend** -## How can I add my custom module? +### How can I add my custom module? Please read the [`Adding Custom Modules`](docs/ADDING_CUSTOM_MODULE.md) section in `docs` -## Attribution + +## 🤝 Contributing + +Contributions to Devty are welcome! If you would like to contribute, please follow these steps: + +1. Fork the repository. +2. Create a new branch: + ```bash + git checkout -b feature/your-feature + ``` +3. Make your changes and commit them: + ```bash + git commit -m 'Add your changes' + ``` +4. Push the branch: + ```bash + git push origin feature/your-feature + ``` +5. Open a pull request. + + +### How can I add my custom module? + +Please read the [`Adding Custom Modules`](docs/ADDING_CUSTOM_MODULE.md) section in `docs` + + +## Community + +
+ + + +
+ +## Attribution This project uses [`DevUtils`](https://devutils.com) as inspiration. + +