diff --git a/README.md b/README.md index 2b327cef..e1158aff 100644 --- a/README.md +++ b/README.md @@ -1 +1,82 @@ -# ChartDB + +

+ ChartDB +
+

+ +

+ Open-source database diagrams editor
+

+ +

+ Community | + Website +

+ +

+ + ChartDB is released under the MIT license. + + + PRs welcome! + + + Slack community channel + + + + + +

+ +--- + +**πŸŽ‰ ChartDB**: +ChartDB is a powerful and intuitive database diagramming editor that runs as a SaaS application via a website. +Effortlessly visualize and design your database schemas with a single **Smart Query** that fetches your entire database structure. +Customize your diagrams, export SQL scripts, and explore a full suite of featuresβ€”all without the need to create an account. +Dive into a seamless database design experience and discover the complete feature set here. + +## Status + +ChartDB is currently in Public Beta. Star and watch this repository to get notified of updates. + +## πŸš€ Getting Started + +1. Go to [ChartDB.io](https://chartdb.io) +2. Click "Go to app" +3. Choose the database that you are using. +4. Take the magic query and run it in your database. +5. Copy and paste the resulting JSON set into ChartDB. +6. Enjoy Viewing & Editing! + +### Supported Databases + +- βœ… PostgresSQL +- βœ… MySQL +- βœ… SQL Server +- βœ… MariaDB +- βœ… SQL Lite + +## πŸ’š Community & Support + +- [Slack](https://chartdb.io/slack) (For live discussion with the community and the ChartDB team) +- [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB) +- [Twitter](https://twitter.com/chartdb) (Get news fast) + +## Contributing + +We welcome community contributions, big or small, and are here to guide you along +the way. Message us in the [ChartDB Community Slack](https://join.slack.com/t/chartdbcommunity/shared_invite/213123123213). Once you contribute, ping us in Slack and we'll send you some ChartDB swag! + +For more information on how to contribute, please see our +[Contributing Guide](/CONTRIBUTING.md). + +This project is released with a [Contributor Code of Conduct](/CODE_OF_CONDUCT.md). +By participating in this project, you agree to follow its terms. + +Thank you for helping us make ChartDB better for everyone :heart:. + +## License + +ChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE) and as commercial software.