modified README

This commit is contained in:
ioBridge 2011-03-27 16:54:00 -04:00
parent e0d87d12c2
commit cbacb8dd08

View File

@ -1,27 +1,33 @@
h1. ThingSpeak h1. ThingSpeak
h3. Before You Begin h3. Before You Begin
1. Install Ruby, RubyGems, Rails, git, and a database like MySQL 1. Install Ruby, RubyGems, Rails, git, and a database like MySQL
2. Download the application using git 2. Download the application using git
3. Install the appropriate gems: sudo bundle install 3. Install the appropriate gems: sudo bundle install
h3. Configuration h3. Configuration
1. Set your database configuration file at config/database.yml (see config/database.yml.example for an example) 1. Set your database configuration file at config/database.yml (see config/database.yml.example for an example)
2. Create the database: rake db:create 2. Create the database: rake db:create
3. Create the database tables: rake db:migrate 3. Create the database tables: rake db:migrate
h3. Run The Application h3. Run The Application
1. Start the server: rails server 1. Start the server: rails server
Your application will now be running at http://localhost:3000/ Your application will now be running at http://localhost:3000/
h2. Changing Application Text h2. Changing Application Text
Make changes to config/locales/en.yml Make changes to config/locales/en.yml
To avoid errors, please ensure your lines start with spaces, not tabs. To avoid errors, please ensure your lines start with spaces, not tabs.
Set your application name using the 'application_name' key. Set your application name using the 'application_name' key.
h2. (Optional) HTTP GET Support h2. (Optional) HTTP GET Support
By default the application will accept channel updates via GET or POST. To only allow POSTs, change the value of GET_SUPPORT found in config/initializers/constants.rb By default the application will accept channel updates via GET or POST. To only allow POSTs, change the value of GET_SUPPORT found in config/initializers/constants.rb
h2. (Optional) Email Setup h2. (Optional) Email Setup
Set your domain, user_name, and password in config/environment.rb Set your domain, user_name, and password in config/environment.rb
Also set your password reset link in app/controllers/mailer.controller.rb line 14 (and uncomment the line) Also set your password reset link in app/controllers/mailer.controller.rb line 14 (and uncomment the line)