Skip to content

Commit

Permalink
Add help section and TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
indragiek committed Jan 7, 2015
1 parent 2fff606 commit d8a7e45
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@

`drive` was originally developed by [Burcu Dogan](https://github.com/rakyll) while working on the Google Drive team. This repository contains the latest version of the code, as she is no longer able to maintain it.

## Table of Contents

- [Requirements](#requirements)
- [Installation](#installation)
- [Platform Packages](#platform-packages)
- [Configuration](#configuration)
- [Usage](#usage)
- [Initializing](#initializing)
- [Pulling](#pulling)
- [Exporting Docs](#exporting-docs)
- [Pushing](#pushing)
- [Publishing](#publishing)
- [Unpublishing](#unpublishing)
- [Trashing and Untrashing](#trashing-and-untrashing)
- [Emptying the Trash](#emptying-the-trash)
- [Listing Files](#listing-files)
- [Quota](#quota)
- [Help](#help)
- [Why another Google Drive client?](#why-another-google-drive-client)
- [Known issues](#known-issues)
- [LICENSE](#license)

## Requirements

go 1.2 or higher is required. See [here](https://golang.org/doc/install) for installation instructions and platform installers.
Expand Down Expand Up @@ -130,7 +152,7 @@ Emptying the trash will permanently delete all trashed files. They will be unrec
$ drive emptytrash
```

### Listing
### Listing Files

The `list` command shows a paginated list of paths on the cloud.

Expand Down Expand Up @@ -160,6 +182,20 @@ The `quota` command prints information about your drive, such as the account typ
$ drive quota
```

### Help

Run the `help` command without any arguments to see information about the commands that are available:

```shell
$ drive help
```

Pass in the name of a command to get information about that specific command and the options that can be passed to it.

```shell
$ drive help push
```

## Why another Google Drive client?

Background sync is not just hard, it is stupid. My technical and philosophical rants about why it is not worth to implement:
Expand Down

0 comments on commit d8a7e45

Please sign in to comment.