step-up 0.2.0 → 0.2.1

data/README.md

@@ -1,32 +1,55 @@
-# StepUp: a project to 'step up' projects
+# StepUp: a project to 'step up' your projects
+StepUp is a tool to manage versioning based on source control management features (i.e. tags and notes of Git). That is, you don't need to keep track of your application version in a file anymore !!!
 
-StepUp is an utility to manage versioning, based on source control management features (i.e. tags and notes of Git). That is, you don't need to keep track of your application version in a file anymore.
-Initially it just supports Git as SCM. But more SCM's are planned in the future.
+## Prerequisite
+This is temporary but for now StepUp just works with Git version 1.7.1 and above.
 
-For now the only feature will help you to check the application version based on the default version pattern from StepUp.
+## Installation
+    gem install step-up
 
-The next (real soon) features to come are:
-- create notes
-- increment versions based on notes
-- pattern of version defined by user
-- and lots more
+## First of all
+Have in mind that StepUp has only Git support for now (more to come soon!!), so any StepUp command must be performed inside a git repository path.
+With that said, run
 
-### Installation
+    stepup init
+This will prepare your repository to use one of the coolest feature of StepUp called ***notes***
+Besides that it will create a file in your project called **.stepuprc** 
+We'll cover more about this in the next sections.
 
-gem install step-up
+## The Basics
+### Check out the version
+    stepup version
+This will tell you the application version based on Git tag.
+Currently the result of this command on StepUp project itself will be
 
-### Usage
+    v0.2.0+1
+The "+1" part means the project has one commit since last version.
+The format of the version is totally customizable through **.stepuprc** which we will cover in the next sections.
 
-1) Enter your directory project
+### Create new version
+    stepup version create --level LEVEL_NAME
+where **LEVEL_NAME** can be 
 
-2) Run StepUp and see the magic 
+* major
+* minor
+* tiny
+* patch
+* rc
 
-### Commands
+This command will ask user for a message for the version and will increment the version number accordingly
 
-stepup
+### Check out the history
+    stepup changelog --top N
+where **N** is the number of versions that will be displayed from newer to older ones
 
-  Shows your application version
-  
-stepup -h
+## StepUp beyond basics
+***Comming soon***
 
-  Shows the current features
+## Report bugs and suggestions
+
+  * [Issue Tracker](https://github.com/kawamanza/step-up/issues)
+
+## Authors
+
+ * [Eric Fer](https://github.com/ericfer)
+ * [Marcelo Manzan](https://github.com/kawamanza)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: step-up
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Marcelo Manzan
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 -02:00
+date: 2011-01-14 00:00:00 -02:00
 default_executable: stepup
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,7 +63,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: StepUp manages a project's versioning through its entire life
+description: StepUp manages a project's versioning through its entire lifecycle
 email: 
 - manzan@gmail.com
 - eric.fer@gmail.com
@@ -93,7 +93,7 @@ files:
 - spec/lib/step-up/ranged_notes_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: https://github.com/redoc/step-up
+homepage: https://github.com/kawamanza/step-up
 licenses: []
 
 post_install_message: