Files
directus/packages/specs/README.md
2021-05-04 18:52:08 -04:00

45 lines
1.5 KiB
Markdown

<img width="250" alt="Logo" src="https://user-images.githubusercontent.com/9141017/88821768-0dc99800-d191-11ea-8c66-09c55ab451a2.png">
![CI](https://github.com/directus/specs/workflows/CI/badge.svg?branch=master)
## 🐰 Introduction
Welcome to API specification for Directus.
## ⚙️ Installation
### Start the swagger dev environment
Run
```
npm run dev
```
## ✨ Updating
TODO
## 🔧 Contributing
Please report any and all quirks / issues you come across as
[an issue](https://github.com/directus/directus/issues/new).
Pull requests are more than welcome and always appreciated. Seeing this is in active development, please make sure to
reach out a member of the core team in an issue or [on Discord](http://discord.gg/directus) before you start working on
a feature or bug to ensure you don't work on the same thing as somebody else :)
## ❤️ Supporting Directus
Directus is a GPLv3-licensed open source project with development made possible by support from our core team,
contributors, and sponsors. It's not easy building premium open-source software; if you would like to help ensure
Directus stays free, please consider becoming a sponsor.
- [Support us through GitHub Sponsors](https://github.com/sponsors/directus)
- [One-time donation through PayPal](https://www.paypal.me/supportdirectus)
## 📄 License
Directus is released under [the GPLv3 license](./LICENSE). Monospace Inc. owns all Directus trademarks and logos on
behalf of our project's community. Copyright © 2006-2020, Monospace Inc.