README.md

# JSend

> JSend API specification for Elixir. Learn more at [omniti-labs/jsend](https://github.com/omniti-labs/jsend).

[![CI](https://github.com/codedge-llc/jsend/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/jsend/actions/workflows/ci.yml)
[![Version](https://img.shields.io/hexpm/v/jsend.svg)](https://hex.pm/packages/jsend)
[![Total Downloads](https://img.shields.io/hexpm/dt/jsend.svg)](https://hex.pm/packages/jsend)
[![License](https://img.shields.io/hexpm/l/jsend.svg)](https://github.com/codedge-llc/jsend/blob/main/LICENSE.md)
[![Last Updated](https://img.shields.io/github/last-commit/codedge-llc/jsend.svg)](https://github.com/codedge-llc/jsend/commits/main)
[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/jsend/)

## Installation

1. Add `jsend` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:jsend, "~> 0.1.0"}
  ]
end
```

## Contributing

### Testing

Unit tests can be run with `mix test`.

### Formatting

This project uses Elixir's `mix format` and [Prettier](https://prettier.io) for formatting.
Add hooks in your editor of choice to run it after a save. Be sure it respects this project's
`.formatter.exs`.

### Commits

Git commit subjects use the [Karma style](http://karma-runner.github.io/5.0/dev/git-commit-msg.html).

## License

Copyright (c) 2024 Codedge LLC (https://www.codedge.io/)

This library is MIT licensed. See the [LICENSE](https://github.com/codedge-llc/jsend/blob/main/LICENSE.md) for details.