From c4cfdaca37682aac0001c68e74aba651db4b987e Mon Sep 17 00:00:00 2001 From: Cameron Corda Date: Wed, 30 Nov 2016 22:00:31 -0800 Subject: [PATCH] Update README to link to wiki, clarify two READMEs closes #14 --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd6a05cd..dfe6929a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ -Bubs gives you a fresh start to our projects, this is the WordPress version. +Bubs gives you a clean start to a WordPress project leveraging a few key pieces: + +* Timber +* Gulp +* Local, Staging, and Production release environments ## Quickstart 1. Download and extract to your project: https://github.com/patronage/bubs-wp/archive/master.zip 2. Run `composer install`, which will initialize the project. 3. There is a line at the top of .gitignore that excludes `wp-content/plugins/*` -- Remove that. -4. Follow the instructions in your `README.md`. +4. You'll have a new top level `README.md` (it's copied from `_init/README.md`). Follow instructions in that file for customizing your project further. + +## Documentations -## Sites using Bubs +Here are a few pages in particular worth checking out from [our wiki](https://github.com/patronage/bubs-wp/wiki) -- [http://www.voteftw.org/](http://www.voteftw.org/) +- [Local development](https://github.com/patronage/bubs-wp/wiki/Local-Development) +- [Site using bubs](https://github.com/patronage/bubs-wp/wiki/Sites-Using-Bubs) +- [Multisite](https://github.com/patronage/bubs-wp/wiki/Multisite)