README.md in buildybuild-0.0.1 vs README.md in buildybuild-1.0.0
- old
+ new
@@ -1,8 +1,8 @@
# Buildybuild
-Buildybuild is a rails generator that gives you everything you need to create a cms.
+Buildybuild is generator that allows you to quickly generate static with either markup or a provided cms.
## Installation
Add this line to your application's Gemfile:
@@ -31,11 +31,11 @@
gem 'rdiscount'
```
## Usage
-This is a rails generator so run the following command:
+This is a rails generator so run:
```bash
$ rails generate buildybuild:cms
# you can pass a name for the generated resource. Default is "page" i.e.:
@@ -55,11 +55,11 @@
- app/views/pages/\_form.html.haml
and appends the following to the bottom of your routes file:
```ruby
- resources :pages, only: [:new, :create]
+ resources :pages, only: [:new, :create]
#keep these at the bottom of your file. They should be the last routes.
get "/:slug", to: "pages#show", as: :slug
get "/:slug/edit", to: "pages#edit", as: :edit_slug
put "/:slug", to: "pages#update", as: :slug
@@ -72,10 +72,19 @@
```bash
rake db:migrate
```
-And you're set. Now you can go to "http://localhost:3000/pages/new" and see your new Content Management System in action!
+And you're set. Now you can go to ```http://localhost:3000/pages/new``` and see your new Content Management System in action!
+
+Or you can create static pages and stick them in ```app/views/pages/```. Then you will automatically have access to the page in your routes.
+
+Observe:
+
+Create a static page called ```app/views/pages/about_us.html.haml```
+
+Then automatically have access to ```http://localhost:3000/about-us```.
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)