@book000/twitterts 0.4.2 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,32 @@
|
|
|
1
|
-
# twitterts
|
|
1
|
+
# 🕊 twitterts
|
|
2
2
|
|
|
3
|
-
Twitter Unofficial Scraping API Library for TypeScript
|
|
3
|
+
[Twitter](https://twitter.com) Unofficial Scraping API Library for TypeScript
|
|
4
|
+
|
|
5
|
+
## 🚀 Install
|
|
6
|
+
|
|
7
|
+
This library is available at npm: [@book000/twitterts](https://www.npmjs.com/package/@book000/twitterts)
|
|
8
|
+
|
|
9
|
+
If you are using npm:
|
|
10
|
+
|
|
11
|
+
```shell
|
|
12
|
+
npm install @book000/twitterts
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
or if you are using yarn:
|
|
16
|
+
|
|
17
|
+
```shell
|
|
18
|
+
yarn add @book000/twitterts
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## ✨ Features
|
|
22
|
+
|
|
23
|
+
- It uses Puppeteer to capture traffic that occurs on `twitter.com`.
|
|
24
|
+
- The data will be retrieved using a Twitter account. A valid Twitter account is required.
|
|
25
|
+
|
|
26
|
+
## 📚 API Document
|
|
27
|
+
|
|
28
|
+
The API documentation for this library is hosted on GitHub Pages and can be found [here](https://book000.github.io/twitterts/).
|
|
29
|
+
Please note that many of the comments in the document are written in Japanese!
|
|
4
30
|
|
|
5
31
|
## 📑 License
|
|
6
32
|
|