Skip to content

Commit

Permalink
Update README to link to wiki, clarify two READMEs
Browse files Browse the repository at this point in the history
closes #14
  • Loading branch information
ccorda authored Dec 1, 2016
1 parent ecccf93 commit c4cfdac
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit c4cfdac

Please sign in to comment.