mechanize.cr/README.md

41 lines
893 B
Markdown

# mechanize(under construction)
This project is inspired by Ruby's [mechanize](https://github.com/sparklemotion/mechanize).
The purpose is to cover all the features of original one.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
mechanize:
github: your-github-user/mechanize
```
2. Run `shards install`
## Usage
```crystal
require "mechanize"
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it (<https://github.com/your-github-user/mechanize/fork>)
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
- [Kanezoh](https://github.com/your-github-user) - creator and maintainer