How to use awesome-elixir: find Elixir and Erlang libraries

What awesome-elixir is and what it is not

awesome-elixir is the h4cc/awesome-elixir repository on GitHub. Its main content is a README file that links to projects and sorts them into topic sections such as Testing, JSON, Networking and OTP.

The list does not vouch for the quality or maintenance of the projects it links to. Treat each entry as a pointer to start your own research.

• It is a directory of links, not a package manager or runtime.
• It covers Elixir and Erlang projects only.
• It is licensed under MIT.

Open the list in your browser

The simplest way to use awesome-elixir is to open the repository page on GitHub and read the README. The table of contents at the top links to every section, so you can jump straight to the topic you need.

If you want a local copy, the README gives this command to clone the repository:

Find a library for a specific task

Start with the topic that matches your job. For example, if you need to test code, open Testing; for data formats, look at JSON, XML or YAML; for network code, check Networking or HTTP.

Each section has a short italic description and a bulleted list. Every entry is a link followed by a one-line description, so you can scan several options quickly before opening any of them.

• Open the section closest to your task from the table of contents.
• Scan the one-line descriptions to shortlist candidates.
• Follow the link to the project to read its documentation and code.

Evaluate a project before you adopt it

Because the list does not verify packages, check each candidate yourself. Look at the project's own repository, its documentation and how recently it is maintained. The README asks contributors to add a :+1: to an issue if they think a package should be added, which shows that entries come from community input.

If you need a package you can rely on without further checking, do not use the list as your only source.

• Read the project's README and documentation.
• Check its issue tracker and recent activity.
• Confirm its licence before you use it in your own project.

Use it to learn the ecosystem

The Resources section lists books, cheat sheets, community sites, newsletters, podcasts, screencasts and styleguides. Newcomers can use it as a map of what exists before they commit to a library.

The section Other Awesome Lists points to other curated lists of Elixir packages if you want more options.

• Books and Cheat Sheets for reference material.
• Community, Newsletters and Podcasts for staying current.
• Styleguides for conventions.

Contribute a missing package

The README explains the contribution process: if you think a package should be added, add a :+1: to the relevant issue or create a new one. The Contributing section of the README covers the rest.