From 77fd747d6f89a8eb87f577de352c7bf1a4199bb3 Mon Sep 17 00:00:00 2001 From: Sarmaged <3858245+Sarmaged@users.noreply.github.com> Date: Thu, 19 Sep 2024 03:26:00 +0300 Subject: [PATCH] Documentation moved to https://style-forge.github.io/ --- CONTRIBUTING.md | 2 +- README.md | 36 +++++++++++++++++------------------- package.json | 2 +- 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51361df..0389d41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,6 +51,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/form/). +For more information, visit our [documentation site](https://style-forge.github.io/form/). Thank you for your contributions! diff --git a/README.md b/README.md index ccf9199..2813c84 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,15 @@ `Style-Forge.Form` package is a versatile and easy-to-use library designed to streamline the creation and management of forms in web applications. It offers a robust set of tools to handle form validation, styling, and submission processes, enhancing user experience and developer productivity. -## Description +## Documentation -To check out docs, visit [style-forge.dev](https://style-forge.dev/form/) +To check out docs, visit [style-forge.github.io](https://style-forge.github.io/form/). -## Contributing +## Support the project ⭐ -We welcome contributions from the community! Please follow these steps to contribute: +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. 🙏 -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. - -For more detailed information, please refer to [CONTRIBUTING.md](CONTRIBUTING.md). - -## License - -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. +style-forge-star ## Modules @@ -74,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: + +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. -- **Dmitrii Sagalov** - *Expert in interface development* - [Sarmaged](https://github.com/Sarmaged) +For more detailed information, please refer to [CONTRIBUTING.md](CONTRIBUTING.md). -## Contact +## License -If you have any questions or suggestions, please open an issue in [Issues](https://github.com/Style-Forge/form/issues). +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. diff --git a/package.json b/package.json index eee309e..2c16727 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "bugs": { "url": "https://github.com/Style-Forge/form/issues" }, - "homepage": "https://style-forge.dev/form/", + "homepage": "https://style-forge.github.io/form/", "publishConfig": { "registry": "https://registry.npmjs.org/" }