From f359f66f936760b73b2e1c9c8aecd8aadd408aa4 Mon Sep 17 00:00:00 2001 From: Valentine Date: Tue, 9 Jul 2024 03:07:22 +0300 Subject: [PATCH] add docs --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/README.md b/README.md index 843b4cd..e4e8fdd 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ You can use this library to get tweets, profiles, and trends trivially. - [Get trends](#get-trends) - [Get following](#get-following) - [Get followers](#get-followers) + - [Create tweet](#create-tweet) + - [Delete tweet](#delete-tweet) + - [Create Retweet](#create-retweet) + - [Delete retweet](#delete-retweet) - [Get scheduled tweets](#get-scheduled-tweets) - [Create scheduled tweet](#create-scheduled-tweet) - [Delete scheduled tweet](#delete-scheduled-tweet) @@ -363,6 +367,65 @@ var cursor string users, cursor, err := scraper.FetchFollowers("Support", 20, cursor) ``` +### Create tweet + +> [!IMPORTANT] +> Requires authentication! + +```golang +tweet, err = scraper.CreateTweet(twitterscraper.NewTweet{ + Text: "new tweet text", + Medias: nil, +}) +``` + +To create tweet with medias, you need to upload media first. Up to 4 medias; jpg, mp4 and gif allowed. + +```golang +var media *twitterscraper.Media +media, err = testScraper.UploadMedia("./photo.jpg") +if err != nil { + t.Error(err) +} +tweet, err = scraper.CreateTweet(twitterscraper.NewTweet{ + Text: "new tweet text", + Medias: []*twitterscraper.Media{ + media, + }, +}) +``` + +### Delete tweet + +> [!IMPORTANT] +> Requires authentication! + +```golang +err := testScraper.DeleteTweet("1810458885008105870"); +``` + +### Create Retweet + +> [!IMPORTANT] +> Requires authentication! + +Returns retweet id, which is not the same as source tweet id. + +```golang +retweetId, err := testScraper.CreateRetweet("1792634158977568997"); +``` + +### Delete retweet + +> [!IMPORTANT] +> Requires authentication! + +To delete retweet use source tweet id instead retweet id. + +```golang +err := testScraper.DeleteRetweet("1792634158977568997"); +``` + ### Get scheduled tweets > [!IMPORTANT]