Update README.md
This commit is contained in:
parent
4f7f10b827
commit
3921f3fa7b
1 changed files with 27 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -1,3 +1,29 @@
|
|||
# Twitter-X-archive-tool
|
||||
|
||||
A small python script that will convert a Twitter/X archive into a static HTML page where all old posts can be viewed. See demo on https://arkiv.andersen.one/twitter.
|
||||
|
||||
## Features
|
||||
|
||||
The purpose of this script was to create an archive of my old Twitter/X profile. The archive will include all posts, but not the comments or retweets that has been made.
|
||||
|
||||
- An introduction with an avatar, name, Twitter/X handle, introduction and number of posts, answers and quote posts.
|
||||
- An information that the profile has been moved.
|
||||
- All posts listed with newest first.
|
||||
- A sidebar with search fields and filter buttons.
|
||||
- Possible to filter only posts or answers, posts with pictures, links or tags, year or used tags.
|
||||
|
||||
## How to use
|
||||
|
||||
The python script must be in same folder as Twitter/X archive, and the archive file must be named "Twitter.zip", and you must include an avatar in the same folder named avatar.png. Run the scrupt in a Linux terminal with Python installed using the code 'python3 generate_archive.py'.
|
||||
|
||||
This will generate the static HTML page as index.html. Media files will be included in the subfolder "media".
|
||||
|
||||
The language of the generated Mastodon archive is **danish**.
|
||||
|
||||
## License
|
||||
|
||||
The script is published under the GPL 3.0 license or later, which means you can use it and modify it for free.
|
||||
|
||||
## Follow me
|
||||
|
||||
Follow me on Mastodon on [@aphandersen@andersen.one](https://andersen.one/@aphandersen).
|
||||
Loading…
Reference in a new issue