Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JrGoodle committed Nov 22, 2017
1 parent 7188943 commit 5084149
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 24 deletions.
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![Build status](https://ci.appveyor.com/api/projects/status/pmf4h6etnb3bbd9y?svg=true)](https://ci.appveyor.com/project/JrGoodle/clowder)
[![Maintainability](https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/maintainability)](https://codeclimate.com/github/JrGoodle/clowder/maintainability)
[![codecov](https://codecov.io/gh/JrGoodle/clowder/branch/master/graph/badge.svg)](https://codecov.io/gh/JrGoodle/clowder)
[![Test Coverage](https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/test_coverage)](https://codeclimate.com/github/JrGoodle/clowder/test_coverage)
[![PyPI version](https://badge.fury.io/py/clowder-repo.svg)](https://badge.fury.io/py/clowder-repo)
[![Python version](https://img.shields.io/pypi/pyversions/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)
[![License](https://img.shields.io/pypi/l/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)
Expand Down Expand Up @@ -116,27 +115,8 @@ $ clowder stash # Stash changes in all projects
$ clowder prune stale_branch # Prune branch 'stale_branch' for all projects
```

See the [clowder commands doc](https://github.com/JrGoodle/clowder/blob/master/docs/commands.md)
for documentation of all command options

For example output from individual commands see the [clowder command examples](https://github.com/JrGoodle/clowder/tree/master/docs#commands)

## The `clowder.yaml` file

See the [clowder.yaml doc](https://github.com/JrGoodle/clowder/blob/master/docs/clowder-yaml.md)
for an explanation of the `clowder.yaml` configuration file

## The clowder repo

See the [clowder repo doc](https://github.com/JrGoodle/clowder/blob/master/docs/clowder-repo.md)
for a description of the structure of the clowder repo cloned in the `.clowder` directory


## Using `clowder` with forks

See the [forks doc](https://github.com/JrGoodle/clowder/blob/master/docs/forks.md)
for a description of the behavior of `clowder` commands with forks
For more information, see [the docs](http://clowder.readthedocs.io/en/latest/)

# Development

See [CONTRIBUTING.md](https://github.com/JrGoodle/clowder/blob/master/CONTRIBUTING.md) for information on setting up your environment for development and for contribution guidelines
See [CONTRIBUTING.md](https://github.com/JrGoodle/clowder/blob/master/CONTRIBUTING.md) for information on setting up your environment for development and contribution guidelines
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ clowder
.. image:: https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/maintainability
:target: https://codeclimate.com/github/JrGoodle/clowder/maintainability

.. image:: https://api.codeclimate.com/v1/badges/56c92799de08f9ef9258/test_coverage
:target: https://codeclimate.com/github/JrGoodle/clowder/test_coverage
.. image:: https://codecov.io/gh/JrGoodle/clowder/branch/master/graph/badge.svg
:target: https://codecov.io/gh/JrGoodle/clowder

.. image:: https://badge.fury.io/py/clowder-repo.svg
:target: https://badge.fury.io/py/clowder-repo
Expand Down

0 comments on commit 5084149

Please sign in to comment.