mechanize.cr/README.md

37 lines
825 B
Markdown
Raw Normal View History

2021-04-30 14:40:06 +02:00
# mechanize(under construction)
2021-04-19 06:50:12 +02:00
2021-04-30 14:40:06 +02:00
This project is inspired by Ruby's [mechanize](https://github.com/sparklemotion/mechanize).
2021-05-03 01:23:07 +02:00
The purpose is to cover all the features of original one.
2021-04-19 06:50:12 +02:00
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
mechanize:
2021-06-02 07:10:42 +02:00
github: Kanezoh/mechanize
2021-04-19 06:50:12 +02:00
```
2. Run `shards install`
## Usage
```crystal
require "mechanize"
```
TODO: Write usage 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