Skip to content

Commit

Permalink
chore: add repo stats to README
Browse files Browse the repository at this point in the history
  • Loading branch information
iShibi committed Nov 11, 2021
1 parent 8938a49 commit d5d8e7d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

An object-oriented Node.js and TypeScript library for interacting with Twitter API v2

## Usage:
## Usage

Fetching details about a twitter user is as easy as this with `twitter.js` library:

Expand Down Expand Up @@ -74,10 +74,14 @@ client.on('filteredTweetCreate', async tweet => {
client.login(credentials);
```

## Future:
## Future

The `twitter.js` library is not ready for production use yet. You can expect breaking changes without any major version bump until we release `v1.0.0` of the library.

There is an autogenerated [documentation website](https://twitter.js.org) for API references. We hope to replace it with a custom one soon. If you love web development, then feel free to discuss how you can contribute towards this goal in our [Discord server](https://discord.gg/f5Pefuskx4).

We are also building a [guide website](https://twitterjs-guide.pages.dev) to teach new users how to use the `twitter.js` library.

## Stats

<img src="https://repobeats.axiom.co/api/embed/866e8a131446bde7e769719852ec3490aa3b62ea.svg" />

0 comments on commit d5d8e7d

Please sign in to comment.