Skip to content

Commit 4981bec

Browse files
committed
Update README [ci skip]
1 parent ffe2aa4 commit 4981bec

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,12 @@ Sage is a WordPress starter theme with a modern development workflow.
1010
## Features
1111

1212
* Sass for stylesheets
13-
* ES6 for JavaScript
13+
* Modern JavaScript
1414
* [Webpack](https://webpack.github.io/) for compiling assets, optimizing images, and concatenating and minifying files
1515
* [Browsersync](http://www.browsersync.io/) for synchronized browser testing
1616
* [Laravel Blade](https://laravel.com/docs/5.3/blade) as a templating engine
1717
* [Controller](https://github.com/soberwp/controller) for passing data to Blade templates
18-
* CSS framework options:
19-
* [Bootstrap 4](http://getbootstrap.com/)
20-
* [Bulma](http://bulma.io/)
21-
* [Foundation](http://foundation.zurb.com/)
22-
* [Tachyons](http://tachyons.io/)
23-
* None (blank slate)
18+
* CSS framework (optional): [Bootstrap 4](https://getbootstrap.com/), [Bulma](https://bulma.io/), [Foundation](https://foundation.zurb.com/), [Tachyons](http://tachyons.io/)
2419
* Font Awesome (optional)
2520

2621
See a working example at [roots-example-project.com](https://roots-example-project.com/).
@@ -30,7 +25,7 @@ See a working example at [roots-example-project.com](https://roots-example-proje
3025
Make sure all dependencies have been installed before moving on:
3126

3227
* [WordPress](https://wordpress.org/) >= 4.7
33-
* [PHP](http://php.net/manual/en/install.php) >= 7.0 (with [`php-mbstring`](http://php.net/manual/en/book.mbstring.php) enabled)
28+
* [PHP](https://secure.php.net/manual/en/install.php) >= 7.0 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)
3429
* [Composer](https://getcomposer.org/download/)
3530
* [Node.js](http://nodejs.org/) >= 6.9.x
3631
* [Yarn](https://yarnpkg.com/en/docs/install)
@@ -44,12 +39,7 @@ Install Sage using Composer from your WordPress themes directory (replace `your-
4439
$ composer create-project roots/sage your-theme-name dev-master
4540
```
4641

47-
During theme installation you will have the options to:
48-
49-
* Update theme headers (theme name, description, author, etc.)
50-
* Select a CSS framework (Bootstrap, Bulma, Foundation, Tachyons, none)
51-
* Add Font Awesome
52-
* Configure Browsersync (path to theme, local development URL)
42+
During theme installation you will have options to update `style.css` theme headers, select a CSS framework, add Font Awesome, and configure Browsersync.
5343

5444
## Theme structure
5545

@@ -103,11 +93,9 @@ Edit `app/setup.php` to enable or disable theme features, setup navigation menus
10393

10494
## Documentation
10595

106-
Sage 8 documentation is available at [https://roots.io/sage/docs/](https://roots.io/sage/docs/).
107-
108-
Sage 9 documentation is currently in progress and can be viewed at [https://github.com/roots/docs/tree/sage-9/sage](https://github.com/roots/docs/tree/sage-9/sage).
109-
110-
Controller documentation is available at [https://github.com/soberwp/controller#usage](https://github.com/soberwp/controller#usage).
96+
* [Sage 8 documentation](https://roots.io/sage/docs/) (stable version of Sage 8, _not_ this repo)
97+
* [Sage 9 documentation](https://github.com/roots/docs/tree/sage-9/sage) (in progress)
98+
* [Controller documentation](https://github.com/soberwp/controller#usage)
11199

112100
## Contributing
113101

0 commit comments

Comments
 (0)