alterware/BetterTwitFix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Misc. Readme changes (Mainly API documentation)

Browse Source
This commit is contained in:
Dylan 2023-07-16 02:19:37 +01:00
parent 2eb4cfef34
commit 07026f9944
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
readme.md
View File

@ -8,17 +8,32 @@ fxtwitter exposed all recently processed tweets publicly via a "latest" and "top
Even though Tweets are public, it was a personal concern for me that a tweet with potentially sensitive information in it could suddenly be shown to however many people were browsing the latest tweets page, and could be used as a tool for harassment. This was removed in [The following commit](https://github.com/dylanpdx/BetterTwitFix/commit/87ba86ba502e73ddb370bd4e5b964548d3272400#diff-a11c36d9b2d53672d6b3d781dca5bef9129159947de66bc3ffaec5fab389d80cL115)
Additionally, vxTwitter has a 'none' cache option, which is intended to be used behind a service like CloudFlare. vxtwitter.com currently runs with this option enabled to protect user privacy.
## How to use (discord side)
## How to use the hosted version
just put the url to the server, and directly after, the full URL to the tweet you want to embed
**I now have a copy of this running on a Linode server, you can use it via the following url**
Just replace twitter.com with vxtwitter.com on the link to the tweet! `https://twitter.com/jack/status/20` -> `https://vxtwitter.com/jack/status/20`
## API
If you're a nerd like me and want to use information about a tweet in your code, you can make a request to `api.vxtwitter.com` to get basic information about a tweet:
`https://api.vxtwitter.com/Twitter/status/1263145271946551300`
```json
{
"date": "Wed May 20 16:31:15 +0000 2020",
"date_epoch": 1589992275,
"hashtags": [],
"likes": 60038,
"mediaURLs": [
"https://video.twimg.com/amplify_video/1263145212760805376/vid/1280x720/9jous8HM0_duxL0w.mp4?tag=13"
],
"replies": 11720,
"retweets": 16729,
"text": "Testing, testing...\n\nA new way to have a convo with exactly who you want. We’re starting with a small % globally, so keep your 👀 out to see it in action. https://t.co/pV53mvjAVT",
"tweetID": "1263145271946551300",
"tweetURL": "https://twitter.com/Twitter/status/1263145271946551300",
"user_name": "Twitter",
"user_screen_name": "Twitter"
}
```
https://vxtwitter.com/[twitter video url] or [last half of twitter url] (everything past twitter.com/)
```
You can also simply type out 'vx' directly before 'twitter.com' in any valid twitter video url, and that will convert it into a working vxTwitter url, for example:
#
**Note**: If you enjoy this service, please considering donating via [Ko-Fi](https://ko-fi.com/dylanpdx) to help cover server costs