add readme examples

Author: mkaput

README.md

@@ -7,7 +7,7 @@
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Last Updated](https://img.shields.io/github/last-commit/mkaput/elixir-bimap.svg)](https://github.com/mkaput/elixir-bimap/commits/master)
 
-Elixir implementation of bidirectional map and multimap.
+Elixir implementation of bidirectional map (`BiMap`) and multimap (`BiMultiMap`).
 
 ## Installation
 
@@ -19,6 +19,40 @@ def deps do
 end
 ```
 
+## Getting started
+
+For more examples, checkout [`BiMap`](https://hexdocs.pm/bimap/BiMap.html) and [`BiMultiMap`](https://hexdocs.pm/bimap/BiMultiMap.html) on hex docs.
+
+### BiMap
+
+```elixir
+iex(1)> Mix.install [:bimap]
+iex(2)> bm = BiMap.new(a: 1, b: 2)
+#BiMap<[a: 1, b: 2]>
+iex(3)> BiMap.get(bm, :a)
+1
+iex(4)> BiMap.get_key(bm, 2)
+:b
+iex(5)> BiMap.put(bm, :a, 3)
+#BiMap<[a: 3, b: 2]>
+iex(6)> BiMap.put(bm, :c, 2)
+#BiMap<[a: 1, c: 2]>
+```
+
+### BiMultiMap
+
+```elixir
+iex(1)> Mix.install [:bimap]
+iex(2)> mm = BiMultiMap.new(a: 1, b: 2, b: 1)
+#BiMultiMap<[a: 1, b: 1, b: 2]>
+iex(3)> BiMultiMap.get(mm, :a)
+[1]
+iex(4)> BiMultiMap.get_keys(mm, 1)
+[:a, :b]
+iex(5)> BiMultiMap.put(mm, :a, 3)
+#BiMultiMap<[a: 1, a: 3, b: 1, b: 2]>
+```
+
 ## License
 
 See the [LICENSE] file for license rights and limitations (MIT).

lib/bimap.ex

@@ -22,6 +22,19 @@ defmodule BiMap do
 
   Keys and values are compared using the exact-equality operator (`===`).
 
+  ## Example
+
+      iex> bm = BiMap.new(a: 1, b: 2)
+      #BiMap<[a: 1, b: 2]>
+      iex> BiMap.get(bm, :a)
+      1
+      iex> BiMap.get_key(bm, 2)
+      :b
+      iex> BiMap.put(bm, :a, 3)
+      #BiMap<[a: 3, b: 2]>
+      iex> BiMap.put(bm, :c, 2)
+      #BiMap<[a: 1, c: 2]>
+
   ## Protocols
 
   `BiMap` implements `Enumerable`, `Collectable` and `Inspect` protocols.

lib/bimultimap.ex

@@ -13,6 +13,17 @@ defmodule BiMultiMap do
 
   Keys and values are compared using the exact-equality operator (`===`).
 
+  ## Example
+
+      iex> mm = BiMultiMap.new(a: 1, b: 2, b: 1)
+      #BiMultiMap<[a: 1, b: 1, b: 2]>
+      iex> BiMultiMap.get(mm, :a)
+      [1]
+      iex> BiMultiMap.get_keys(mm, 1)
+      [:a, :b]
+      iex> BiMultiMap.put(mm, :a, 3)
+      #BiMultiMap<[a: 1, a: 3, b: 1, b: 2]>
+
   ## Protocols
 
   `BiMultiMap` implements `Enumerable`, `Collectable` and `Inspect` protocols.