update README

humaine-anac · Apr 16, 2020 · d1ec3c7 · d1ec3c7
1 parent 0af902f
commit d1ec3c7
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# repository
+# @humaine/utils
 
-A template repository
+A utility library for the HUMAINE applications.
 
 ## Setup
 
@@ -10,8 +10,14 @@ npm install
 
 ## Usage
 
-```bash
-npm start
+```typescript
+import { quantize } from '@humaine-utils/math'
+
+quantize(1.324, 2); // 1.32
+
+import { optionsToUrl } from '@humaine-utils/url';
+
+optionsToUrl({host: 'localhost'}); // http://localhost
 ```
 
 ## Contributing