Permalink
Browse files

Change read me.

  • Loading branch information...
1 parent f29e168 commit e533836e170928966bd6a64d518d60b369af4d52 @yoshiori committed May 1, 2013
Showing with 36 additions and 5 deletions.
  1. +36 −5 README.md
View
@@ -1,24 +1,55 @@
# Rubygems::Mirror::Command
-TODO: Write a gem description
+gem mirror fetcher and start mirror server.
## Installation
Add this line to your application's Gemfile:
- gem 'rubygems-mirror-command'
+```ruby:Gemfile
+gem "rubygems-mirror-command", :git => "git@github.com:yoshiori/rubygems-mirror-command.git"
+```
And then execute:
- $ bundle
+```
+$ bundle
+```
Or install it yourself as:
- $ gem install rubygems-mirror-command
+```
+$ git clone git@github.com:yoshiori/rubygems-mirror-command.git
+$ cd rubygems-mirror-command
+$ gem build rubygems-mirror-command.gemspec
+$ rubygems-mirror-command-0.0.1.gem
+```
## Usage
-TODO: Write usage instructions here
+### fetch files
+```
+$ rubygems-mirror-command fetch
+```
+
+### start server
+
+```
+$ rubygems-mirror-command server
+```
+
+Or specified Port
+
+```
+$ rubygems-mirror-command server 3999
+```
+
+### install gem for local mirror
+
+```
+$ gem install rails -r --source http://localhost:4000/
+```
+
## Contributing

0 comments on commit e533836

Please sign in to comment.