initial commit

README.md

@@ -0,0 +1,21 @@
+# SsbBfe
+
+Binary Field Encodings (BFE) for Secure Scuttlebutt (SSB).
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `ssb_bfe` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:ssb_bfe, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at <https://hexdocs.pm/ssb_bfe>.
+