add minimal readme

zbindenren · Oct 24, 2020 · d69aaee · d69aaee
1 parent 0147ba5
commit d69aaee
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# sfmt [![](https://github.com/zbindenren/sfmt/workflows/build/badge.svg)](https://github.com/zbindenren/sfmt/actions) [![PkgGoDev](https://pkg.go.dev/badge/github.com/zbindenren/sfmt)](https://pkg.go.dev/github.com/zbindenren/sfmt)
+
+Simple library to format slices.
+
+## Install
+
+```bash
+go get github.com/zbindenren/sfmt
+```
+
+## Usage
+
+See [sfmt_test.go](../master/sfmt_test.go) on how to use it.
+