updated docs

This commit is contained in:
James Baxley 2016-08-31 22:11:12 -04:00 committed by Norbert de Langen
parent b5bd13d643
commit 6e161cb11a
3 changed files with 3 additions and 10 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 MiB

View File

@ -2,6 +2,6 @@
We welcome your help to make this component better. This document will help to streamline the contributing process.
## Development Setup
## Development Structure
@@TODO
This project is setup using typescript and jest for testing. All components live in the `/src` directory and tests live under `/__tests__` directories within `/src`.

View File

@ -8,7 +8,7 @@ react-storybook-addon-backgrounds
=======================
[![Build Status](https://travis-ci.org/NewSpring/react-storybook-addon-backgrounds.svg?branch=travis)](https://travis-ci.org/NewSpring/react-storybook-addon-backgrounds) [![Coverage Status](https://coveralls.io/repos/github/NewSpring/react-storybook-addon-backgrounds/badge.svg?branch=master)](https://coveralls.io/github/NewSpring/react-storybook-addon-backgrounds?branch=master)
<!-- ![screenshot]() -->
![React Storybook Screenshot](./.storybook/backgrounds.gif)
### Development
@ -30,10 +30,3 @@ To test the project run:
```bash
$ npm test
```
### TODO
- [ ] setup deployment to github pages
- [ ] 95% coverage for project
- [ ] document project
- [ ] write article