Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mykewould/crutches

Some Elixir support
https://github.com/mykewould/crutches

Last synced: 7 days ago
JSON representation

Some Elixir support

Awesome Lists containing this project

README 

        
# Crutches [![Build Status]][build-link] [![Docs Status]][docs-ci-link] [![Hex Version]][version-link] ![License]



Utility library for Elixir, designed to complement the standard library bundled

with the language. This project aims to provide extra functions that can be

useful in most projects, but haven't made it into the standard library yet.

Similar to and inspired by [ActiveSupport][ActiveSupport].



 - [Documentation][docs]

 - [License][license] — MIT

 - [How to contribute][contributing-info] — We don't bite. Join in on

   the fun!



## Installation



You can get Crutches from Hex. Add the following to your `mix.exs` file and run

`mix deps.get` afterwards:



```elixir

defp deps do

  [{:crutches, "~> 1.0.0"}]

end

```



## Usage



If you want to import all functions provided by Crutches, `use` it in your

module:



```elixir

defmodule Foo do

  use Crutches

end

```



The above aliases `Crutches` as `C` and `Crutches.Format` as `F`. All modules

and functions in the library will be available to you. Take a look at the [API

reference][docs] for a list of modules.



If you only need a specific part of the library, you can `import` or `alias`

it:



```elixir

defmodule Bar do

  import Crutches.Option

  # Or:

  alias Crutches.Option

end

```



Again, refer to the [API reference][docs] for a list of modules and functions

that you can find in Crutches.



## Project status, compatibility and versioning



Since `v1.0.0` all APIs are stable and subject to [semantic versioning][semver].



We specifically test our code against the following versions of Erlang/OTP

and Elixir:



Erlang: 18.0, 19.0, 20.0

Elixir: 1.1.1, 1.2.6, 1.3.4, 1.4.0, 1.5.1



## Learn Elixir with us!



Crutches is a great for Elixir beginners to contribute to. We are writing

convenience functions as an addition to the Elixir standard library, a lot of

which are inspired by [ActiveSupport][ActiveSupport] (a similar project from the Ruby world).



The great thing about a utility library is that it is easy to contribute

without having to know a lot about the entire codebase. You can easily add a

new function in a vacuum, without having to know about the rest of the codebase.

Furthermore, we provide a list of features to be implemented, complete with

tests, so you can get started right away, even if you don't have any ideas.



We want to be a safe place for anyone to get started with Elixir or with

contributing to an open source project. If you see anything that isn't proper

in your eyes, then be sure to let one of the collaborators know!



Sounds good? Take a look at the [contributing information][contributing-info]

to get started. If anything is unclear, or if you are unsure about something,

feel free to contact one of the collaborators.



 [docs]:http://hexdocs.pm/crutches/

 [contributing-info]: https://github.com/mykewould/crutches/blob/master/CONTRIBUTING.md

 [license]:https://github.com/mykewould/crutches/blob/master/LICENSE



 [Build Status]:https://travis-ci.org/mykewould/crutches.svg?branch=master

 [Hex Version]:https://img.shields.io/hexpm/v/crutches.svg?label=hex%20version

 [Docs Status]:http://inch-ci.org/github/mykewould/crutches.svg?branch=master

 [License]:https://img.shields.io/hexpm/l/crutches.svg



 [build-link]:https://travis-ci.org/mykewould/crutches

 [version-link]:https://hex.pm/packages/crutches

 [docs-ci-link]:http://inch-ci.org/github/mykewould/crutches



 [semver]:http://semver.org/

 [ActiveSupport]:https://github.com/rails/rails/tree/master/activesupport