docs: add usage section to readme

Open-Tech-Foundation · Apr 20, 2023 · 83a8f64 · 83a8f64
1 parent 80814a2
commit 83a8f64
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/fuzzy-socks-behave.md b/.changeset/fuzzy-socks-behave.md
@@ -0,0 +1,5 @@
+---
+"@opentf/utils": patch
+---
+
+Added usage section to readme
diff --git a/README.md b/README.md
@@ -30,6 +30,18 @@ Using pnpm
 pnpm add @opentf/utils
 ```
 
+## Usage
+
+```ts
+import { range, camelCase, sleep } from "@opentf/utils";
+
+range(1, 5); //=> [1, 2, 3, 4, 5]
+
+camelCase('i phone') //=> 'iPhone'
+
+await sleep(1000); // It suspends the exection for 1 second.
+```
+
 ## Documentation
 
 Please visit [https://js-utils.pages.dev](https://js-utils.pages.dev) to get started.