Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shootingfly/what_happen

Tell you what happen when x changes to y.
https://github.com/shootingfly/what_happen

Last synced: 3 months ago
JSON representation

Tell you what happen when x changes to y.

Awesome Lists containing this project

README

        

# What Happen

[![Travis CI build](https://img.shields.io/travis/shootingfly/what_happen/master.svg?style=flat-square)](https://travis-ci.org/shootingfly/what_happen)
[![Built with Crystal](https://img.shields.io/badge/built%20with-crystal-000000.svg?style=flat-square)](https://crystal-lang.org/)
[![Latest release](https://img.shields.io/github/release/shootingfly/what_happen.svg?style=flat-square)](https://github.com/shootingfly/what_happen/releases)
[![API docs](https://img.shields.io/badge/api_docs-online-brightgreen.svg?style=flat-square)](https://shootingfly.github.io/what_happen/)

Tell you what happen when x changes to y.

Work on methods without any arguments or all arguments have default values.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
what_happen:
github: shootingfly/what_happen
```

2. Run `shards install`

## Usage

```crystal
require "what_happen"

puts what_happen(from: [1, 2, 3], to: 1) # => ["first", "first?", "min", "min?"]
```

## Expection

It doesn't work on the following methods.
```crystal
["transpose", "to_h", "sample", "sum", "product"]
```

## Contributing

1. Fork it ()
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

- [Shootingfly](https://github.com/shootingfly) - creator and maintainer

## Thanks

Thanks to jbodah for his awesome work on [suggest_rb](https://github.com/jbodah/suggest_rb)