Skip to content
This repository has been archived by the owner on Dec 9, 2022. It is now read-only.

Commit

Permalink
Improves README
Browse files Browse the repository at this point in the history
  • Loading branch information
Pedro Cunha committed Sep 25, 2017
1 parent 7ee4657 commit 595d01b
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
tmp
dist
paddle
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,40 @@
# Paddle

Paddle is a command line tool for data archival and processing.
Paddle is a command line tool for canoe data archival and processing.

Work in progress.
## Setup

Make sure you have Go installed on your machine and that you checkout the repo to
the right folder. By default should be:

```
mkdir -p ~/go/src/github.com/deliveroo
cd ~/go/src/github.com/deliveroo
git clone [email protected]:deliveroo/paddle.git
cd paddle
```

You will need create a `$HOME/.paddle.yaml` that contains the bucket name, e.g:

```
> cat $HOME/.paddle.yaml
bucket: roo-bucket
```

You will also need to create a `$HOME/.aws/config` or `$HOME/.aws/credentials` so Paddle can connect to AWS, e.g.:

```
> cat $HOME/.aws/credentials
[default]
aws_access_key_id=xxx
aws_secret_access_key=yyy
region=eu-west-1
```


```
$ go build
```

## Usage

Expand Down
9 changes: 2 additions & 7 deletions cli/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,8 @@ var cfgFile string
// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command{
Use: "paddle",
Short: "A brief description of your application",
Long: `A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
Short: "Canoe tool for data archival and processing",
Long: "Canoe tool for data archival and processing",
// Uncomment the following line if your bare application
// has an action associated with it:
// Run: func(cmd *cobra.Command, args []string) { },
Expand Down

0 comments on commit 595d01b

Please sign in to comment.