mirror/mastodon-embed-timeline
1
0
Fork 1
mirror of https://gitlab.com/idotj/mastodon-embed-timeline.git synced 2025-05-24 08:52:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update comments

Browse Source
This commit is contained in:
i.j 2023-11-13 09:39:37 +00:00
parent b38e1a7e19
commit 5ba805c48b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -40,23 +40,23 @@ Great, you have a Mastodon timeline running in your page.
Edit the the JS file _mastodon-timeline.js_ and at the beginning find these two lines: Edit the the JS file _mastodon-timeline.js_ and at the beginning find these two lines:
```javascript ```javascript
instance_url: 'Your Mastodon instance', instance_url: 'Your Mastodon instance (not including the last `/` symbol)',
timeline_type: 'local', timeline_type: 'local',
``` ```
Enter your Mastodon instance URL (not including the last `/` symbol) and reload the page. You should see toots from your local instance in your timeline. Enter your Mastodon instance URL and reload the page. You should see toots from your local instance in your timeline.
If you want to show a profile timeline then change the `timeline_type` to `profile` and set the following values: If you want to show a profile timeline then change the `timeline_type` to `profile` and set the following values:
```javascript ```javascript
user_id: 'Your user ID number on Mastodon instance', user_id: 'Your user ID number on Mastodon instance',
profile_name: 'Your user name on Mastodon instance (including the @ symbol at the beginning)', profile_name: 'Your user name on Mastodon instance (including the `@` symbol at the beginning)',
``` ```
If you prefer to show a timeline with a specific hashtag then change the `timeline_type` to `hashtag` and enter the name of the hashtag (not including the `#` symbol): If you prefer to show a timeline with a specific hashtag then change the `timeline_type` to `hashtag` and enter the name of the hashtag:
```javascript ```javascript
hashtag_name: 'YourHashtag', hashtag_name: 'YourHashtag (not including the `#` symbol)',
``` ```
Also you have some parameters to customize your embed timeline: Also you have some parameters to customize your embed timeline: