tweak readme

ZYMoridae · Jun 15, 2019 · 9548029 · 9548029
1 parent e24af0b
commit 9548029
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 node_modules
 lib
 package-lock.json
-yarn.lock
+yarn.lock
+
+README.html
diff --git a/README.md b/README.md
@@ -1 +1,23 @@
-# ms-pagination
+# ms-pagination
+
+## Installing
+```
+npm install @josephzhou/ms-pagination
+```
+
+## Example
+### How to use it
+
+**Import package**
+```
+import PaginationComponent from "@josephzhou/ms-pagination";
+```
+
+**Parameters**
+
+| Parameters    | Type                                                     | Description                                                        |   |   |
+|---------------|----------------------------------------------------------|--------------------------------------------------------------------|---|---|
+| count         | number                                                   | Total pages                                                        |   |   |
+| initialPage   | number                                                   | The page indicated when component initialized (default value is 1) |   |   |
+| onPageChanged | (page: number, perPage: number, orderBy: string) => void | This function will be called when page number changed              |   |   |
+