Skip to content

Commit

Permalink
Add how to signup and update to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
naoty committed Aug 12, 2012
1 parent 50f47c6 commit 318e3f4
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 13 deletions.
52 changes: 40 additions & 12 deletions README.md
Expand Up @@ -6,37 +6,65 @@ CLI for cui-about.me (http://github.com/naoty/cui-aboutme)

Add this line to your application's Gemfile:

gem 'cuiabout'
```ruby
gem 'cuiabout'
```

And then execute:

$ bundle
```sh
$ bundle
```

Or install it yourself as:

$ gem install cuiabout
```sh
$ gem install cuiabout
```

## Usage

Print how to use this gem.

$ cuiabout help
```sh
$ cuiabout help

Usage: cuiabout ACTION
Usage: cuiabout ACTION

cuiabout [username] # Prints user's profile
cuiabout show [username] # Prints user's profile
cuiabout list # Prints all user names
cuiabout [username] # Prints user's profile
cuiabout show [username] # Prints user's profile
cuiabout list # Prints all user names
```

Print all user names.

$ cuiabout list
naoty
soplana
```sh
$ cuiabout list
naoty
soplana
```

Print a specific user's profile.

$ cuiabout naoty
```sh
$ cuiabout naoty
```

Signup with your name, password, and any other information.

```sh
$ cuiabout signup naoty email=naoty.k@gmail.com github=http://github.com/naoty
password:
Success!
```

Update your profile.

```sh
$ cuiabout update naoty blog=http://naoty.hatenablog.com location=Tokyo
password:
Success!
```

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion cuiabout.gemspec
Expand Up @@ -4,7 +4,7 @@ require File.expand_path('../lib/cuiabout/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["naoty"]
gem.email = ["naoty.k@gmail.com"]
gem.description = %q{This gem helps to download hackers' profiles, and upload your profile.}
gem.description = %q{CLI for cui-about.me (http://cui-about.me)}
gem.summary = %q{CLI for cui-about.me}
gem.homepage = "http://github.com/naoty/cuiabout"

Expand Down

0 comments on commit 318e3f4

Please sign in to comment.