docs: add license and sponsors sections (#40)

un-ts · Aug 11, 2022 · b379d2c · b379d2c
1 parent 4fd6f25
commit b379d2c
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 9 deletions.
diff --git a/.changeset/healthy-pumpkins-repair.md b/.changeset/healthy-pumpkins-repair.md
@@ -0,0 +1,5 @@
+---
+"dl-iconfont": patch
+---
+
+docs: add license and sponsors sections
diff --git a/README.md b/README.md
@@ -22,6 +22,8 @@ An [iconfont][] downloader via [puppeteer][].
     - [Environments](#environments)
     - [Command](#command)
   - [API](#api)
+- [Sponsors](#sponsors)
+- [Backers](#backers)
 - [Changelog](#changelog)
 - [License](#license)
 
@@ -43,11 +45,11 @@ npm i -g dl-iconfont
 
 #### Environments
 
-1. `ICONFONT_PROJECT` (required)
-2. `ICONFONT_LOGIN` (required)
-3. `ICONFONT_PASSWORD` (required)
-4. `ICONFONT_DOWNLOAD_FILE` (optional)
-5. `PUPPETEER_HEADLESS` (optional)
+1. `ICONFONT_PROJECT` (optional, can be provided via `-p` option)
+2. `ICONFONT_LOGIN` (optional, can be provided via `-l` option)
+3. `ICONFONT_PASSWORD` (optional, can be provided via `-p` option)
+4. `ICONFONT_DOWNLOAD_FILE` (optional, can be provided via `downloadFile` argument)
+5. `PUPPETEER_HEADLESS` (optional, can be provided via `-h` option)
 
 #### Command
 
@@ -71,19 +73,33 @@ Options:
 ```ts
 import { fetchJsUrl, download } from 'dl-iconfont'
 
-const jsUrl = await fetchJsUrl({ projectId, login, password, headless })
+const jsUrl = await fetchJsUrl({ project, login, password, headless })
+
 await download(jsUrl, 'iconfont.js')
 ```
 
+## Sponsors
+
+| 1stG                                                                                                                               | RxTS                                                                                                                               | UnTS                                                                                                                               |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| [![1stG Open Collective backers and sponsors](https://opencollective.com/1stG/organizations.svg)](https://opencollective.com/1stG) | [![RxTS Open Collective backers and sponsors](https://opencollective.com/rxts/organizations.svg)](https://opencollective.com/rxts) | [![UnTS Open Collective backers and sponsors](https://opencollective.com/unts/organizations.svg)](https://opencollective.com/unts) |
+
+## Backers
+
+| 1stG                                                                                                                             | RxTS                                                                                                                             | UnTS                                                                                                                             |
+| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| [![1stG Open Collective backers and sponsors](https://opencollective.com/1stG/individuals.svg)](https://opencollective.com/1stG) | [![RxTS Open Collective backers and sponsors](https://opencollective.com/rxts/individuals.svg)](https://opencollective.com/rxts) | [![UnTS Open Collective backers and sponsors](https://opencollective.com/unts/individuals.svg)](https://opencollective.com/unts) |
+
 ## Changelog
 
 Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md).
 
 ## License
 
-[MIT][]
+[MIT][] © [Edisonsu768][]
 
 [dotenv]: https://github.com/motdotla/dotenv
+[edisonsu768]: https://github.com/Edisonsu768
 [iconfont]: https://www.iconfont.cn
 [mit]: http://opensource.org/licenses/MIT
 [puppeteer]: https://github.com/puppeteer/puppeteer
diff --git a/package.json b/package.json
@@ -4,9 +4,9 @@
   "type": "module",
   "description": "An iconfont downloader via puppeteer.",
   "repository": "https://github.com/un-ts/dl-iconfont.git",
-  "author": "Zhenggang Su <[email protected]>",
+  "author": "Zhenggang Su (https://github.com/Edisonsu768) <[email protected]>",
   "contributors": [
-    "JounQin <[email protected]>"
+    "JounQin (https://www.1stG.me) <[email protected]>"
   ],
   "donate": {
     "recipients": [