Skip to content

README.md: fix typos and line breaks #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deining wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md: fix typos and line breaks #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Supertar is TAR on steroids with compression, encryption and web-interface

Supertar (short star) combines archiving, compression and encryption but makes it easy to list, search, add or remove new files and directories without first decrypting and decompressing the archive. Trough a built in web-interface, you can browse an archive, view and extract single files.
Supertar (short star) combines archiving, compression and encryption but makes it easy to list, search, add or remove new files and directories without first decrypting and decompressing the archive. Through a built in web-interface, you can browse an archive, view and extract single files.

We all know TAR. It's a great tool to archive a lot of files. You can later compress and encrypt your archive. But if you want to search for, extract, add or delete a specific file or directory you have to decrypt first and then decompress the archive. This is a cumbersome process. Supertar to the rescue.

Expand All @@ -26,7 +26,7 @@ supertar --help

## Built-in web server? Why?

Imagine you have an archive with some images and videos. They are named IMG_1234.jpg and MOV_4321.avi. You are searching for a specific image, but don't know the exact name. Just start the Supertar web-server with the archive file and you can browse the archive and click on each image or video to directly show them in your browser. This is much mor comfortable than extracting the whole archive to find what you are looking for.
Imagine you have an archive with some images and videos. They are named IMG_1234.jpg and MOV_4321.avi. You are searching for a specific image, but don't know the exact name. Just start the Supertar web-server with the archive file and you can browse the archive and click on each image or video to directly show them in your browser. This is much more comfortable than extracting the whole archive to find what you are looking for.

![Supertar demo](images/demo.gif)

Expand Down Expand Up @@ -116,7 +116,7 @@ Supertar has a simple file format that can be read easily by your own parser. So
-> Compressed and encrypted item (n bytes)
```

`[0]` The magic number is always `1337`
`[1]` The version numer is currently `1`
`[2]` The compression flag is either `0` to disable compression or `1` to enable compression using Zstandard. More compression algorithms will be added later.
`[0]` The magic number is always `1337`
`[1]` The version number is currently `1`
`[2]` The compression flag is either `0` to disable compression or `1` to enable compression using Zstandard. More compression algorithms will be added later.
`[3]` Mode contains the file mode and the permission bits.