shard-ameba/README.md

47 lines
1,016 B
Markdown
Raw Normal View History

2017-10-26 17:47:42 +00:00
<p align="center">
<img src="https://media.githubusercontent.com/media/veelenga/bin/master/ameba/logo.png" width="200">
<h3 align="center">Ameba</h3>
<p align="center">Code style linter for Crystal<p>
<p align="center">
<sup>
<i>
(a single-celled animal that catches food and moves about by extending fingerlike projections of protoplasm)
</i>
</sup>
</p>
</p>
## Status
**CONSTRUCTION ZONE** :construction:
2017-10-26 16:46:58 +00:00
## Installation
Add this to your application's `shard.yml`:
```yaml
2017-10-26 17:47:42 +00:00
development_dependencies:
2017-10-26 16:46:58 +00:00
ameba:
2017-10-26 17:47:42 +00:00
github: veelenga/ameba
2017-10-26 16:46:58 +00:00
```
## Usage
```crystal
require "ameba"
2017-10-26 17:47:42 +00:00
Ameba.run
```
2017-10-26 16:46:58 +00:00
## Contributing
2017-10-26 17:47:42 +00:00
1. Fork it ( https://github.com/veelenga/ameba/fork )
2017-10-26 16:46:58 +00:00
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
2017-10-26 17:47:42 +00:00
- [veelenga](https://github.com/veelenga) Vitalii Elenhaupt - creator, maintainer