From ee24171e372fbb3a8e006dcba5c7eb26e28b5cc5 Mon Sep 17 00:00:00 2001 From: Aurelsicoko Date: Wed, 8 Aug 2018 12:21:24 +0200 Subject: [PATCH] Update README --- README.md | 70 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 43 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 8d8a1610c0..e03a1ccba2 100755 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

API creation made simple, secure and fast.

-

The most advanced open-source Content Management Framework to build powerful API with no effort.

+

The most advanced open-source Headless-CMS to build powerful API with no effort.


@@ -32,35 +32,51 @@

- +


-## Quick start +## Getting Started -We've been working on a major update to Strapi for several months now, rewriting the core framework and the administration panel. Performances has been increased, Developer eXperience has been improved and a brand new plugins -ecosystem has been introduced. **Both versions are available, we still recommend you to use v1 for production usage.**. +[Read the Getting Started tutorial](https://strapi.io/getting-started) or follow the steps below: + +#### Installation + +```bash +npm install strapi@alpha -g +```` + +**We recommend to use the latest version of Strapi** to start your new project. Some breaking changes might happen, new releases are shipped every two weeks. + +#### Create a new project + +```bash +strapi new my-project +``` + +It will generate a brand new project with the default features (authentication, permissions, content management, content type builder & file upload). + +Then, you're ready to start your project: + +```bash +cd my-project +strapi start +``` + +**Congratulations, you made it! Enjoy 🎉** + +--- + +You can also give it a try using Heroku. However one of the main feature (content type builder) won't work due to the writing files restriction of Heroku. Deploy -#### Alpha +--- -The alpha has support for the latest version of Node.js (v9) and npm (v5). -```bash -npm install strapi@alpha -g -``` - -#### Stable -This is the production-ready version of Strapi (v1). You should also consider that the migration to v3 will not be easy due to many breaking changes. -```bash -npm install strapi -g -``` - -Read the [Getting started](https://strapi.io/getting-started) page to create your first project using Strapi. ## Features @@ -73,19 +89,17 @@ Read the [Getting started](https://strapi.io/getting-started) page to create you - **Powerful CLI:** Scaffold projects and APIs on the fly. - **SQL & NoSQL databases:** Work with Mongo as a main database, also supports Postgres, MySQL, etc. -## Philosophy ? +**[See more on our website](https://strapi.io/overview)** -> At [Strapi](https://strapi.io), everything we do we believe in changing the status quo of web development. Our products are simple to use, user friendly and production-ready. +## Contributing -Web and mobile applications needed a powerful, simple to use and production-ready API-driven solution. That's why we created Strapi, an open-source Content Management Framework (CMF) for exposing your content (data, media) accross multi-devices. - -Halfway between a CMS and a framework, Strapi takes advantages of both worlds. A powerful dashboard to easily manage your content with a flexible framework layer to develop and integrate specific features. +Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request to the project. ## Support For more information on the upcoming version, please take a look to our [ROADMAP](https://github.com/strapi/strapi/projects). -### Community support +#### Community support For general help using Strapi, please refer to [the official Strapi documentation](https://strapi.io/documentation/). For additional help, you can use one of this channel to ask question: @@ -95,13 +109,15 @@ For general help using Strapi, please refer to [the official Strapi documentatio - [Twitter](https://twitter.com/strapijs) - [Facebook](https://www.facebook.com/Strapi-616063331867161). -### Professional support +#### Professional support -[Strapi Solutions](https://strapi.io), the company behind Strapi, provides a full range of solutions to get better results, faster. We're always looking for the next challenge: coaching, consulting, training, customization, etc. [Drop us an email](mailto:support@strapi.io) to see how we can help you. +[Strapi Solutions](https://strapi.io), the company behind Strapi, provides a full range of solutions to get better results, faster. We're always looking for the next challenge: coaching, consulting, training, customization, etc. + +[Drop us an email](mailto:support@strapi.io) to see how we can help you. ### Migration -Follow our [migration guides](https://github.com/strapi/strapi/wiki) on the wiki to keep your Strapi projects updated. +Follow our [migration guides](https://github.com/strapi/strapi/wiki) on the wiki to keep your projects up-to-date. ## License