From d5d8e7d801e9622b7862c3391460c46c31cc84b4 Mon Sep 17 00:00:00 2001 From: Shubham Parihar Date: Thu, 11 Nov 2021 10:37:21 +0530 Subject: [PATCH] chore: add repo stats to README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 85f31a1..96c6f4e 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 + +