README.md in totem-0.0.3 vs README.md in totem-0.0.4
- old
+ new
@@ -7,13 +7,11 @@
- Ruby on Rails inspired folder structure.
- Lightweight and simple code.
- Integrated console.
- Uses built in Ruby classes and avoids depending on 3rd party gems.
- Designed for MRI and JRuby.
-- Easily extensible through gems or directly in your project.
- - ActiveRecord (coming soon).
- - Tribe (coming soon).
+- Easily extensible through gems or directly in your project (ActiveRecord gem coming soon).
- Designed for multi-threaded applications.
## Installation
Add this line to your application's Gemfile:
@@ -25,9 +23,26 @@
$ bundle
Or install it yourself as:
$ gem install totem
+
+## Usage
+
+Create a new project called "my_app" in the current directory:
+
+ $ totem new my_app
+
+You must now setup Bundler (and rvm, rbenv, etc) for your new project:
+
+ $ bundle
+
+You can now create your custom classes in the "app" directory.
+You will need to manually "require" your classes in "app/loader.rb" since there isn't an auto-loader.
+
+Totem comes with an IRB based console similar to Rails:
+
+ $ totem console
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)