# Pieces Documentation

We're trying to make Pieces easy to understand. Let us know via an [issue][issue]
if you can't find the information you are looking for here.

## Getting started

The [README][README] contains information for getting started with pieces:

 - [Installation](https://github.com/drpheltright/pieces/blob/master/README.md#installation)
 - [How does Pieces work?](https://github.com/drpheltright/pieces/blob/master/README.md#how-it-works)
 - [Create a UI styleguide for rails](https://github.com/drpheltright/pieces/blob/master/README.md#using-with-rails)
 - [Create a static site](https://github.com/drpheltright/pieces/blob/master/README.md#create-static-site)

## Documentation

For documentation and howtos look no further:

 - [pieces.yml](https://github.com/drpheltright/pieces/blob/master/docs/pieces.yml.md) (you really ought to read this)

## Working with Pieces

If you want to work with Pieces in your own project you should probably have a
look at these links:

 - [Code of Conduct](https://github.com/drpheltright/pieces/blob/master/docs/code_of_conduct.md)
 - [Contributing](https://github.com/drpheltright/pieces/blob/master/docs/contributing.md)
 - [MIT License](https://github.com/drpheltright/pieces/blob/master/docs/license.md)

## Help

Find help and more in the Pieces [README][README] or [raise an issue][issue] on
github.

[README]: https://github.com/drpheltright/pieces/blob/master/README.md
[issue]: https://github.com/drpheltright/pieces/issues