From e2f9005a2f618b3a8e6b38a626aa56e64cc4c458 Mon Sep 17 00:00:00 2001 From: Ben Haynes Date: Fri, 7 Aug 2020 22:16:34 -0400 Subject: [PATCH] formatting and spacing --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/readme.md b/readme.md index e72dc1abce4d3..542234ff909e9 100644 --- a/readme.md +++ b/readme.md @@ -16,6 +16,8 @@ Directus is a real-time API and App dashboard for managing SQL database content. **[Learn more about Directus on our website.](https://directus.io)** +
+ ## 🚧 Alpha **DO NOT USE THIS VERSION IN PRODUCTION.** @@ -31,6 +33,8 @@ This is *pre-release* software, therefore migrations will not be provided, break - [ ] Caching - [ ] Rate Limiting +
+ ## ⚙️ Installation Create a new Directus project by running the following npm command: @@ -47,6 +51,8 @@ yarn create directus-project my-project Simply follow the setup prompts and the CLI will create your new project directory (eg: `my-project`), configuration file, and initial database. To get the most out of Directus, and to ensure you have the latest security patches, it is important to keep your projects up-to-date. For more information, view our docs on [Updates & Migrations](#). +
+ ## 📌 Requirements Directus only requires Node.js (or [PHP](https://github.com/directus/api-next)), and supports most operating systems and SQL database vendors. @@ -73,6 +79,8 @@ Directus only requires Node.js (or [PHP](https://github.com/directus/api-next)), _Other operating systems may also work, but are not officially supported._ +
+ ## 🤔 Community Help In addition to the [Directus Documentation](https://docs.directus.io), you can also request help via the following channels: @@ -83,6 +91,8 @@ In addition to the [Directus Documentation](https://docs.directus.io), you can a * [Twitter](https://twitter.com/directus) (Latest News) * [YouTube](https://www.youtube.com/c/DirectusVideos/featured) (Video Tutorials) +
+ ## ❤️ Contributing & Sponsoring Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting Pull Requests.