docs/README.md

60 lines
1.9 KiB
Markdown

[![CircleCI](https://img.shields.io/circleci/project/kitematic/kitematic.svg)](https://circleci.com/gh/kitematic/kitematic/tree/master)
[![bitHound Score](https://app.bithound.io/kitematic/kitematic/badges/score.svg)](http://app.bithound.io/kitematic/kitematic)
![Kitematic Logo](https://cloud.githubusercontent.com/assets/251292/5269258/1b229c3c-7a2f-11e4-96f1-e7baf3c86d73.png)
Kitematic is a simple application for managing Docker containers on Mac OS X.
## Installing Kitematic
[Download the latest version](https://kitematic.com/download) of Kitematic.
## Documentation
Kitematic's documentation and other information can be found at [http://kitematic.com/docs](http://kitematic.com/docs).
### Development
- `npm install`
To run the app in development:
- `npm start`
### Building the Mac OS X Package
- `npm run release`
### Unit Tests
- `npm test`
## Uninstalling
- Remove Kitematic.app
```bash
# remove app data
rm -rf ~/Library/Application\ Support/Kitematic
```
## Bugs and Feature Requests
Have a bug or a feature request? Please first read the [Issue Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/kitematic/kitematic/issues/new).
## Roadmap & Contributing
We will be accepting pull requests that help with our [roadmap](ROADMAP.md).
Please read through our [Contributing Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
## Community
Keep track of development and community news.
- Follow [@kitematic on Twitter](https://twitter.com/kitematic).
- Read and subscribe to [The Kitematic Blog](http://blog.kitematic.com).
## Copyright and License
Code released under the [Apache license](LICENSE).