Skip to content

Commit

Permalink
added package details and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
girishramnani committed Jun 9, 2017
1 parent 6491444 commit e537997
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Ksuid

ksuid is a Elixir library that can generate KSUIDs.
ksuid is a zero dependency Elixir library for generating KSUIDs.

Read more about ksuid [here](https://segment.com/blog/a-brief-history-of-the-uuid/)

## How To

Expand All @@ -13,18 +15,19 @@ iex> Ksuid.generate()
## TODO

- [x] Generate KSUID
- [ ] Parsing KSUIDS
- [ ] Decode BASE62 method
- [ ] Write tests
- [x] Parsing KSUIDS
- [x] Decode BASE62 method
- [x] Write tests
- [ ] Write Documentation

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ksuid` to your list of dependencies in `mix.exs`:

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

## Credit

[Segmentio/ksuid](https://github.com/segmentio/ksuid)
17 changes: 17 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,31 @@ defmodule Ksuid.Mixfile do
elixir: "~> 1.4",
build_embedded: Mix.env == :prod,
start_permanent: Mix.env == :prod,
description: description(),
deps: deps()]
end

def description do
"""
ksuid is a zero dependency Elixir library for generating KSUIDs.
"""
end

def application do
# Specify extra applications you'll use from Erlang/Elixir
[extra_applications: [:logger]]
end

defp deps do
end

defp package do
[
name: :ksuid,
files: ["lib", "mix.exs", "README*", "LICENSE*"],
maintainers: ["Girish Ramnani"],
licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/girishramnani/elixir-ksuid" }
]
end
end

0 comments on commit e537997

Please sign in to comment.