|
1 | 1 | # Excoding |
2 | 2 |
|
3 | | -**TODO: Add description** |
| 3 | +String encoding/decoding NIF using rust [encoding](https://crates.io/crates/encoding) library. |
4 | 4 |
|
5 | 5 | ## Installation |
6 | 6 |
|
7 | | -If [available in Hex](https://hex.pm/docs/publish), the package can be installed |
8 | | -by adding `excoding` to your list of dependencies in `mix.exs`: |
| 7 | +The package can be installed by adding `excoding` to your list of dependencies in `mix.exs`: |
9 | 8 |
|
10 | 9 | ```elixir |
11 | 10 | def deps do |
12 | 11 | [ |
13 | | - {:excoding, "~> 0.1.0"} |
| 12 | + {:excoding, "~> 1.0"} |
14 | 13 | ] |
15 | 14 | end |
16 | 15 | ``` |
17 | 16 |
|
18 | | -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) |
19 | | -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can |
20 | | -be found at <https://hexdocs.pm/excoding>. |
| 17 | +It requires rustc and cargo to compile. Easiest way to install required tools is |
| 18 | +to use excellent [rustup](https://rustup.rs/) script. |
| 19 | + |
| 20 | +## License |
| 21 | + |
| 22 | +The MIT License (MIT) |
| 23 | + |
| 24 | +Copyright (c) 2020, Milan Jaric. |
| 25 | + |
| 26 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 27 | +of this software and associated documentation files (the "Software"), to deal |
| 28 | +in the Software without restriction, including without limitation the rights |
| 29 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 30 | +copies of the Software, and to permit persons to whom the Software is |
| 31 | +furnished to do so, subject to the following conditions: |
| 32 | + |
| 33 | +The above copyright notice and this permission notice shall be included in |
| 34 | +all copies or substantial portions of the Software. |
| 35 | + |
| 36 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 37 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 38 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 39 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 40 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 41 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 42 | +THE SOFTWARE. |
| 43 | + |
21 | 44 |
|
0 commit comments