MyFavMirrors/minio
1
0
Fork 0
mirror of https://github.com/minio/minio.git synced 2025-11-07 12:52:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Harshavardhana
2014-12-20 09:09:35 -08:00
parent d2784ba73d
commit d4c05f11c7
5 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
cmd/minio-cli/README.md
View File

@@ -1,8 +1,8 @@
## Introduction
`minio-cli` is cli option stub builder for ``minio`` project on top of [codegangsta/cli](https://github.com/codegangsta/cli),
`minio-cli` is a stub builder for new commands,options on top of [codegangsta/cli](https://github.com/codegangsta/cli),
Ideal for rapid prototyping and encouraging new contributors to the project
Idea behind providing a simple tool for rapid prototyping and encouraging new contributors to the project
## Usage
@@ -12,21 +12,14 @@ You just need to set its command name and options:
$ minio-cli -options option1,option2,option3 [command]
```
Generates three files namely [command].go, [command]-options.go, [application].md
Generates three files namely [command].go, [command]-options.go, [command].md
## Example
If you want to start to building `bucket` command which has options `get`, `put`, `list`:
```bash
$ minio-cli -options get,put,list foo
$ ls foo/
foo-options.go foo.go foo.md
```
## Installation
```bash
$ go get github.com/minio-io/minio
$ make install
$ minio-cli -options get,put,list bucket
$ ls bucket/
bucket-options.go bucket.go bucket.md
```