diff --git a/CHANGELOG.md b/CHANGELOG.md index d57d3c8..56d6854 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +### HEAD +* Add `composer.json` and update installation instructions ([#1583](https://github.com/roots/sage/issues/1583)) + ### 8.4.0: December 1st, 2015 * Update to Bootstrap 3.3.6 ([#1578](https://github.com/roots/sage/pull/1578)) * Remove unnecessary underscore ([#1577](https://github.com/roots/sage/pull/1577)) diff --git a/README.md b/README.md index af9e0a3..00df0e0 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,31 @@ See a complete working example in the [roots-example-project.com repo](https://g ## Theme installation -Clone the git repo - `git clone https://github.com/roots/sage.git` and then rename the directory to the name of your theme or website. +Bottom line is you want to get the files in this repo into your local development environment. There are many ways to do this, two of which we will cover here. + +### via Command-line + +If you're already [using Composer to manage WordPress](https://roots.io/using-composer-with-wordpress/), then you might consider using composer's `create-project` command to download Sage. + +The example below assumes you're using Bedrock. If you're not, simply change the target path accordingly. + +```sh +composer create-project roots/sage web/app/themes/your-theme-name-here +``` + +Then activate the theme via [wp-cli](http://wp-cli.org/commands/theme/activate/). + +```sh +wp theme activate your-theme-name-here +``` + +### via WordPress Admin Panel + +1. [Download the latest release](https://github.com/roots/sage/releases/latest) of Sage. +2. In your WordPress admin panel, navigate to Appearance->Themes +3. Click Add New +4. Click Upload Theme +5. Upload the zip file that you downloaded. ## Theme setup diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..d9e6d58 --- /dev/null +++ b/composer.json @@ -0,0 +1,30 @@ +{ + "name": "roots/sage", + "type": "wordpress-theme", + "license": "MIT", + "description": "The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.", + "homepage": "https://roots.io/sage/", + "authors": [ + { + "name": "Ben Word", + "email": "ben@benword.com", + "homepage": "https://github.com/retlehs" + }, + { + "name": "Scott Walkinshaw", + "email": "scott.walkinshaw@gmail.com", + "homepage": "https://github.com/swalkinshaw" + } + ], + "keywords": [ + "wordpress" + ], + "support": { + "issues": "https://github.com/roots/sage/issues", + "forum": "https://discourse.roots.io/" + }, + "require": { + "php": ">=5.4.0", + "composer/installers": "~1.0" + } +} \ No newline at end of file