From e86edc4b34da8c5dbfc0af1d88794d6e9f4898cc Mon Sep 17 00:00:00 2001 From: Sarmaged <3858245+Sarmaged@users.noreply.github.com> Date: Thu, 19 Sep 2024 03:46:09 +0300 Subject: [PATCH] Documentation moved to https://style-forge.github.io/ --- CONTRIBUTING.md | 2 +- README.md | 24 +++++++++++++++++------- package.json | 2 +- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7924184..d307212 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,6 @@ If you find a bug or have a feature request, please open an issue on GitHub. Pro - Be respectful and considerate in your communications. - Follow the project's code of conduct. -For more information, visit our [documentation site](https://style-forge.dev/patterns/). +For more information, visit our [documentation site](https://style-forge.github.io/patterns/). Thank you for your contributions! diff --git a/README.md b/README.md index ac3c8b3..5e2c5c9 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,13 @@ ## Documentation -To check out docs, visit [style-forge.dev](https://style-forge.dev/patterns/) +To check out docs, visit [style-forge.github.io](https://style-forge.github.io/patterns/) -## License +## Support the project ⭐ -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. +If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us getting known and grow the community. 🙏 + +style-forge-star ## Modules @@ -62,10 +64,18 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file -## Authors +## Contributing + +We welcome contributions from the community! Please follow these steps to contribute: -- **Dmitrii Sagalov** - *Expert in interface development* - [Sarmaged](https://github.com/Sarmaged) +1. Fork the repository. +2. Create a new branch: `git checkout -b feature/branch-name`. +3. Make your changes and commit them: `git commit -am 'Add some feature'`. +4. Push your changes to the forked repository: `git push origin feature/branch-name`. +5. Create a pull request in the original repository. -## Contact +For more detailed information, please refer to [CONTRIBUTING.md](CONTRIBUTING.md). -If you have any questions or suggestions, please open an issue in [Issues](https://github.com/Style-Forge/patterns/issues). +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. diff --git a/package.json b/package.json index 7d32c33..52c6de7 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "bugs": { "url": "https://github.com/Style-Forge/patterns/issues" }, - "homepage": "https://style-forge.dev/patterns/", + "homepage": "https://style-forge.github.io/patterns/", "publishConfig": { "registry": "https://registry.npmjs.org/" }