Copy over latest readme

This commit is contained in:
rijkvanzanten
2020-07-31 19:10:09 -04:00
parent fd357a8d74
commit cb92a078b0

View File

@@ -1,19 +1,52 @@
# Directus Node
<img width="250" alt="Logo" src="https://user-images.githubusercontent.com/9141017/88821768-0dc99800-d191-11ea-8c66-09c55ab451a2.png">
> This is an early alpha version. **DO NOT** use this in production.
## 🐰 Introduction
## Installation
Welcome to the preview release of the next major version of Directus.
Run `npx directus create <directory>`
**NOTE:** This is pre-release software and should be treated as such. DO NOT use this in production.
Migrations between versions aren't provided, and breaking changes might happen at any release.
Start the API by running `npx directus start`.
## ⚙️ Installation
## Contributing
_Directus requires NodeJS 10+_
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
We've created a little CLI tool you can use to quickly start up a Directus project. You can use it by running:
Please make sure to update tests as appropriate.
```
npx create-directus-project my-project
```
## License
or using yarn:
```
yarn create directus-project my-project
```
on the command line. This will create the given directory, setup the configuration, and install the database.
## ✨ Updating
To update an existing Directus project, navigate to your project directory and run:
```
npm update
```
## 🔧 Contributing
Please report any and all quirks / issues you come across as [an issue](https://github.com/directus/next/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.
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)