From 35043425a749a7d81f2820b85caa856ed13da453 Mon Sep 17 00:00:00 2001 From: Luke Towers Date: Thu, 15 Aug 2019 09:09:54 -0600 Subject: [PATCH] Changes to readme --- README.md | 56 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 024b9be94..e84fe7bbf 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,14 @@ October

-[October](http://octobercms.com) is a Content Management Framework (CMF) and web platform whose sole purpose is to make your development workflow simple again. It was born out of frustration with existing systems. We feel building websites has become a convoluted and confusing process that leaves developers unsatisfied. We want to turn you around to the simpler side and get back to basics. +[October](https://octobercms.com) is a Content Management Framework (CMF) and web platform whose sole purpose is to make your development workflow simple again. It was born out of frustration with existing systems. We feel building websites has become a convoluted and confusing process that leaves developers unsatisfied. We want to turn you around to the simpler side and get back to basics. October's mission is to show the world that web development is not rocket science. [![Build Status](https://travis-ci.org/octobercms/october.svg?branch=develop)](https://travis-ci.org/octobercms/october) [![License](https://poser.pugx.org/october/october/license.svg)](https://packagist.org/packages/october/october) -### Learning October - -The best place to learn October is by [reading the documentation](https://octobercms.com/docs) or [following some tutorials](https://octobercms.com/support/articles/tutorials). - -You may also watch these introductory videos for [beginners](https://vimeo.com/79963873) and [advanced users](https://vimeo.com/172202661). There is also the excellent video series by [Watch & Learn](https://watch-learn.com/series/making-websites-with-october-cms). - -### Installing October +## Installing October Instructions on how to install October can be found at the [installation guide](https://octobercms.com/docs/setup/installation). @@ -33,15 +27,41 @@ If you plan on using a database, run this command: php artisan october:install ``` -### Development Team +## Learning October + +The best place to learn October is by [reading the documentation](https://octobercms.com/docs) or [following some tutorials](https://octobercms.com/support/articles/tutorials). + +You may also watch these introductory videos for [beginners](https://vimeo.com/79963873) and [advanced users](https://vimeo.com/172202661). There is also the excellent video series by [Watch & Learn](https://watch-learn.com/series/making-websites-with-october-cms). + +## Contributing + +Before sending a Pull Request, be sure to review the [Contributing Guidelines](.github/CONTRIBUTING.md) first. + +## Coding standards + +Please follow the following guides and code standards: + +* [PSR 4 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) +* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) +* [PSR 1 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) + +## Code of Conduct + +In order to ensure that the OctoberCMS community is welcoming to all, please review and abide by the [Code of Conduct](CODE_OF_CONDUCT.md). + +## Security Vulnerabilities + +Please review [our security policy](https://github.com/octobercms/october/security/policy) on how to report security vulnerabilities. + +## Development Team October was created by [Alexey Bobkov](http://ca.linkedin.com/pub/aleksey-bobkov/2b/ba0/232) and [Samuel Georges](https://www.linkedin.com/in/samuel-georges-0a964131/). The core maintainer is [Luke Towers](https://luketowers.ca/) and other maintainers include [Ben Thomson](https://github.com/bennothommo) and [Denis Denisov](https://github.com/w20k). -### Foundation library +## Foundation library The CMS uses [Laravel](https://laravel.com) as a foundation PHP framework. -### Contact +## Contact You can communicate with us using the following mediums: @@ -50,18 +70,6 @@ You can communicate with us using the following mediums: * [Join us on Slack](https://octobercms-slack.herokuapp.com/) to chat with us. * [Join us on IRC](https://octobercms.com/chat) to chat with us. -### License +## License The OctoberCMS platform is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). - -### Contributing - -Before sending a Pull Request, be sure to review the [Contributing Guidelines](.github/CONTRIBUTING.md) first. - -### Coding standards - -Please follow the following guides and code standards: - -* [PSR 4 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) -* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) -* [PSR 1 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)