cleaned up readme
This commit is contained in:
wukko
parent
7f533b3485
commit
324d58991f
51
README.md
51
README.md
|
|
@ -1,5 +1,5 @@
|
|||
# cobalt
|
||||
Best way to save content you love.
|
||||
Best way to save what you love.
|
||||
|
||||
Live: [co.wukko.me](https://co.wukko.me/)
|
||||
|
||||
|
|
@ -8,49 +8,48 @@ Live: [co.wukko.me](https://co.wukko.me/)
|
|||
[](https://crowdin.com/project/cobalt) [](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) [](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
|
||||
|
||||
## What's cobalt?
|
||||
cobalt is a social media downloader with zero bullshit. It's friendly, efficient, and doesn't bother you with shock ads or privacy invasion "consent" popups.
|
||||
cobalt is a social and media platform downloader that doesn't piss you off.
|
||||
|
||||
It tries to preserve original media quality, and in most cases you get best quality possible (you can set your preferences in settings).
|
||||
It's fast, friendly, and doesn't have any bullshit that modern web is filled with: no ads, trackers, or analytics. Paste the link, get the video, move on. It's that simple. Just how it should be.
|
||||
|
||||
## Supported services
|
||||
| Service | Video + Audio | Only audio | Additional features |
|
||||
| -------- | :---: | :---: | :----- |
|
||||
| Twitter | ✅ | ✅ | Ability to save multiple videos/GIFs from a single tweet. |
|
||||
| Twitter Spaces | ❌️ | ✅ | Audio metadata. |
|
||||
| YouTube & Shorts | ✅ | ✅ | Support for 8K, 4K, HDR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
|
||||
| YouTube Music | ❌ | ✅ | Audio metadata. |
|
||||
| Reddit | ✅ | ✅ | GIFs and videos. |
|
||||
| TikTok & douyin | ✅ | ✅ | Video downloads with or without watermark; image slideshow downloads without watermark. |
|
||||
| SoundCloud | ❌ | ✅ | Audio metadata, downloads from private links. |
|
||||
| bilibili.com | ✅ | ✅ | |
|
||||
| Tumblr | ✅ | ✅ | |
|
||||
| Vimeo | ✅ | ❌️ | |
|
||||
| VK Videos & Clips | ✅ | ❌️ | |
|
||||
| Service | Video + Audio | Only audio | Additional features |
|
||||
| -------- | :---: | :---: | :----- |
|
||||
| Twitter | ✅ | ✅ | Ability to save multiple videos/GIFs from a single tweet. |
|
||||
| Twitter Spaces | ❌️ | ✅ | Audio metadata. |
|
||||
| YouTube & Shorts | ✅ | ✅ | Support for 8K, 4K, HDR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
|
||||
| YouTube Music | ❌ | ✅ | Audio metadata. |
|
||||
| Reddit | ✅ | ✅ | GIFs and videos. |
|
||||
| TikTok | ✅ | ✅ | Video downloads with or without watermark; image slideshow downloads without watermark. Full audio downloads. |
|
||||
| SoundCloud | ❌ | ✅ | Audio metadata, downloads from private links. |
|
||||
| bilibili.com | ✅ | ✅ | |
|
||||
| Tumblr | ✅ | ✅ | |
|
||||
| Vimeo | ✅ | ❌️ | |
|
||||
| VK Videos & Clips | ✅ | ❌️ | |
|
||||
|
||||
## cobalt API
|
||||
cobalt has an open API that you can use for free. It's pretty straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/API.md) and see for yourself.
|
||||
cobalt has an open API that you can use for free. It's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/API.md) and see for yourself.
|
||||
|
||||
## How to contribute translations
|
||||
You can translate cobalt to any language you want on [cobalt's crowdin](https://crowdin-co.wukko.me/). Feel free to ignore QA errors if you think you know better. If you don't see a language you want to translate cobalt to, open an issue, and I'll add it to crowdin.
|
||||
You can translate cobalt to any language you want on [cobalt's Crowdin](https://crowdin-co.wukko.me/). Feel free to ignore QA errors if you think you know better. If you don't see a language you want to translate cobalt to, open an issue, and I'll add it to Crowdin.
|
||||
|
||||
### Translation guidelines:
|
||||
- All text is **ALWAYS** stylized as **lowercase** unless it's STRESSED LIKE THIS or is an internal value like `{ContactLink}` or `{appName}`.
|
||||
- Example: "`this is a live video, i am yet to learn how to look into future. wait for the stream to finish and try again!`".
|
||||
Notice how **everything is lowercase**, no matter the punctuation marks? Yes, that's cobalt's style and you have to follow it.
|
||||
- Avoid formal language. Leave it for big and classy tech companies. Use informal language wherever possible.
|
||||
- Strings are **ALWAYS** stylized as lowercase unless it's STRESSED LIKE THIS or is an internal value like `{ContactLink}`.
|
||||
- Keep translations lively, friendly, and fun. Translate strings as if the user was your buddy.
|
||||
- Automatic translations from original language are not valid, and will be ignored.
|
||||
- You can (and should) rephrase sentences as long as they keep the same point, if you think it'd be better that way.
|
||||
- You can (and should) rephrase sentences as long as they keep the same sense and send the same message as original.
|
||||
- You can add wordplays or puns if it feels natural to do so.
|
||||
- Even though I love cursing, keep that to minimum in translations, and do **NOT** use any offensive words.
|
||||
- Check if there are issues in UI with your localization, and optimize it accordingly, or open an issue.
|
||||
- Add "(in english)" translated to your language at the end of `ChangelogLastCommit`, `ChangelogLastMajor`, and `ChangelogOlder`. Those are always kept exclusively in English (for now), due to how often changelog changes.
|
||||
- Sample translation to Russian: `"ChangelogLastCommit": "последний коммит (на английском)"`
|
||||
- Do **NOT** use offensive or explicit vocabulary.
|
||||
- Check if there are issues in UI with your localization, and optimize it accordingly. If impossible, open an issue.
|
||||
- Be nice.
|
||||
|
||||
## Host an instance yourself
|
||||
You might find cobalt's source code a bit messy, but I do my best to improve it with every commit.
|
||||
|
||||
### Requirements
|
||||
- Node.js 14.16 or above
|
||||
- Node.js 17.5 or above
|
||||
- git
|
||||
|
||||
### npm modules
|
||||
|
|
|
|||
Loading…
Reference in a new issue