From: Tatsuki Sugiura <sugi@nemui.org>
Date: Wed, 23 Mar 2016 06:16:18 +0000 (+0900)
Subject: Update README and add to package.
X-Git-Tag: v0.0.8~1
X-Git-Url: http://git.sourceforge.jp/view?p=osdn-codes%2Fosdn-cli.git;a=commitdiff_plain;h=b7becde38734b41fd34df9b7d1548a82e4815d78

Update README and add to package.
---

diff --git a/README.md b/README.md
index 721daa0..4c4089d 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,51 @@
-# Osdn::Cli
+# OSDN Command Line Interface
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/osdn/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+OSDN command line interface using REST API.
 
-TODO: Delete this and the text above, and describe your gem
+## Requirement
 
-## Installation
-
-Add this line to your application's Gemfile:
+* ruby (>= 1.9.3)
+* gem build environment or pre-build ffi gem
+* libcurl 
 
-```ruby
-gem 'osdn-cli'
-```
+On debian (ubuntu) system, you can install with following packages.
 
-And then execute:
+    $ sudo apt-get install ruby ruby-ffi libcurl3
 
-    $ bundle
+## Installation
 
-Or install it yourself as:
+You can install by rubygem, type following on terminal. 
 
     $ gem install osdn-cli
 
 ## Usage
 
-TODO: Write usage instructions here
+First you need to login to API with 'login' subcommand.
+
+    $ osdn login
 
-## Development
+To get command list use help.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ osdn help
+    osdn [global-options] <command> [command-options] [args]
+    osdn help <command>
+    Global Options:
+      -h --help      Show help message. use 'help <command>' for specific command. 
+      -v --verbose   Increase log level (multiple)
+      -q --quiet     Decrease log level (multiple)
+    Avaiable Commands:
+      help
+      login          Login and save access token.
+      package        Manipulate frs packages of project
+      release        Manipulate frs releases of project
+      relfile        Manipulate frs files of project
+      frs_mkdirs     Make directory tree for current project release
+      frs_upload     Upload local file tree and create package/release implicitly.
+      ping           Test API request.
+      vars           Get/set request environment variable.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/osdn-cli.
+Bug reports and pull requests are welcome on OSDN at https://osdn.jp/projects/osdn-codes/ticket/
 
diff --git a/osdn-cli.gemspec b/osdn-cli.gemspec
index 4a59150..1cf543f 100644
--- a/osdn-cli.gemspec
+++ b/osdn-cli.gemspec
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Non-intaractive manipulation tool for OSDN}
   spec.homepage      = "https://osdn.jp/projects/osdn-codes/wiki/CommandLineInterface"
 
-  files = (Pathname.glob("exe/**/*") + Pathname.glob("lib/**/*")).reject{|f| f.directory? }.map(&:to_s)
+  files = %w(ChangeLog README.md) + (Pathname.glob("exe/**/*") + Pathname.glob("lib/**/*")).reject{|f| f.directory? }.map(&:to_s)
   spec.files         = files.reject { |f| f.match(%r{^(test|spec|features)/}) || f.match(%r{(~|\.bak|\.orig|\.rej)$}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -25,6 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "osdn-client", ">= 0.0.20160304"
-#  spec.add_dependency "ruby-progressbar"
   spec.add_dependency "hashie"
 end