aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorwabilin <[email protected]>2020-08-01 09:16:44 +0900
committerwabilin <[email protected]>2020-08-01 09:16:44 +0900
commit3345f689d479525eb889618de998b272b7f52028 (patch)
tree4c26ce4f21b5de7705e6ecfdcdf7cf35cf4be91a /README.md
parentRemove getSchedule from index (diff)
downloadholo-schedule-3345f689d479525eb889618de998b272b7f52028.tar.xz
holo-schedule-3345f689d479525eb889618de998b272b7f52028.zip
Update readme for API changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index e8484d8..c7f2e73 100644
--- a/README.md
+++ b/README.md
@@ -16,10 +16,14 @@ npm install holo-schedule
## Usage
-```js
-const { parseScheduleHtml, getScheduleHtml } = require('holo-schedule')
+```ts
+import parseScheduleHtml from 'holo-schedule'
+// or:
+// const parseScheduleHtml = require('holo-schedule').default
-// You can also get html by yourself
+import getScheduleHtml from 'holo-schedule/lib/getScheduleHtml'
+
+// You can also get the html by yourself
const html = await getScheduleHtml()
// The dict stores steamers' icon data, you can save for using next time