diff --git a/LICENSE b/LICENSE index ab60297..c66c7c0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 +Copyright (c) shawjia (github.com/shawjia) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 19ad702..ed64e9f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # geektime -> API client for time.geekbang.org +> API client for time.geekbang.org (极客时间) ## INSTALL ```bash @@ -30,7 +30,7 @@ const client = new Geektime('phone', 'pass'); ### products() -产品列表,返回 专栏/视频课/微课/其他 +返回产品列表 (专栏/视频课/微课/其他) ### intro(cid) @@ -49,9 +49,12 @@ const client = new Geektime('phone', 'pass'); 返回音频列表 ### NOTE -- *cid:* 专栏 id -- *id:* 文章 id + +| param | note | +| --- | --- | +| cid | 专栏 id | +| id | 文章 id | ## License -MIT © [shawjia](https://github.com/shawjia) +MIT diff --git a/package.json b/package.json index 69db55a..f9d8c44 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "API client for time.geekbang.org", "main": "index.js", "repository": "https://github.com/shawjia/geektime", - "author": "shawjia", + "author": "shawjia (github.com/shawjia)", "license": "MIT", "scripts": { "test": "ava"