Document mix dep usage, add badges, bump ver

tynanbe · Jan 26, 2021 · c1ebc4a · c1ebc4a
1 parent 7f6d29a
commit c1ebc4a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # shellout
 
+[![Hex Package](https://img.shields.io/hexpm/v/shellout?color=ffaff3&label=%F0%9F%93%A6)](https://hex.pm/packages/shellout)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3?label=%F0%9F%93%9A)](https://hexdocs.pm/shellout/)
+[![License](https://img.shields.io/hexpm/l/shellout?color=ffaff3&label=%F0%9F%93%83)](https://hex.pm/packages/shellout)
+
 A Gleam wrapper for [`Elixir.System.cmd/3`](https://hexdocs.pm/elixir/master/System.html#cmd/3)
 
 ## Usage
@@ -19,6 +23,25 @@ output
 status
 ```
 
+### As a dependency of your Mix project
+
+Add shellout to `mix.exs`:
+
+```elixir
+{:shellout, "~> 0.1"},
+```
+
+Tooling improvements are in the works.
+For now the following commands should work.
+
+From your project's root dir:
+
+```bash
+$ mix deps.get
+$ sh -c 'cd deps/shellout/ && mix deps.get && mix compile'
+$ mix compile  # or mix escript.build, etc
+```
+
 ## Test
 
 ```bash

diff --git a/gleam.toml b/gleam.toml
@@ -1,5 +1,5 @@
 name = "shellout"
-version = "0.1.0"
+version = "0.1.1"
 
 [repository]
 type = "github"

diff --git a/mix.exs b/mix.exs
@@ -4,7 +4,7 @@ defmodule Shellout.MixProject do
   def project do
     [
       app: :shellout,
-      version: "0.1.0",
+      version: "0.1.1",
       description: "A Gleam wrapper for Elixir.System.cmd/3",
       package: %{
         files: [