The Open Standard for Generative UI
Add README, LICENSE & CONTRIBUTING files
Rabi Shanker Guha748471408f09
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 000000000..24d9d32b8--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,24 @@+# Contributing Guidelines++Thank you for considering contributing to *crayon*! This document provides guidelines for contributing.++## How to Contribute++1. Fork the repository.+2. Create a new branch (`git checkout -b feature/amazing-feature`) & make your changes.+3. Ensure your code follows our style guidelines.+4. Update the README.md & autogenerate docs if needed.+5. Open a Pull Request++## Bug Reports++Use Github Issues to report bugs. When reporting bugs, please include:+- A clear description of the issue+- Steps to reproduce+- Expected vs actual behavior+- Your environment details++## Questions?++We're happy to help! Feel free to open an issue for any questions or concerns.+You can also join our [Discord](https://discord.gg/Pbv5PsqUSv) to chat with the teamdiff --git a/LICENSE b/LICENSEnew file mode 100644index 000000000..2a703f519--- /dev/null+++ b/LICENSE@@ -0,0 +1,21 @@+The MIT License (MIT)++Copyright (c) 2011-2024 The Bootstrap Authors++Permission is hereby granted, free of charge, to any person obtaining a copy+of this software and associated documentation files (the "Software"), to deal+in the Software without restriction, including without limitation the rights+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell+copies of the Software, and to permit persons to whom the Software is+furnished to do so, subject to the following conditions:++The above copyright notice and this permission notice shall be included in+all copies or substantial portions of the Software.++THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN+THE SOFTWARE.diff --git a/README.md b/README.mdnew file mode 100644index 000000000..0ff9269cc--- /dev/null+++ b/README.md@@ -0,0 +1,4 @@+## crayon++Generative UI SDK for your AI agents. <br />+Get started with the [docs](https://crayonai.org/docs/quickstart)diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.tsindex f48b6f310..e205bebd2 100644--- a/docs/docusaurus.config.ts+++ b/docs/docusaurus.config.ts@@ -125,8 +125,7 @@ const config: Config = {items: [{label: "Discord",- // TODO: Add Discord invite link- href: "https://discordapp.com/invite/thesysdev",+ href: "https://discord.gg/Pbv5PsqUSv",},{label: "X",