From bf506f5da9cf27859184b37ba0fcd542f593755a Mon Sep 17 00:00:00 2001 From: wukko Date: Tue, 15 Aug 2023 16:12:38 +0600 Subject: [PATCH] updated readme --- README.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ed1eaaee..a558bf6e 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ Live web app: [co.wukko.me](https://co.wukko.me/) ![cobalt logo with repeated logo pattern background](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/pattern.png "cobalt logo with repeated logo pattern background") -[![Crowdin](https://badges.crowdin.net/cobalt/localized.svg)](https://crowdin.com/project/cobalt) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=active+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=resolved+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) +[![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=active+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) ## What's cobalt? -cobalt is a social and media platform downloader that doesn't piss you off. +cobalt is social and media platform downloader that doesn't piss you off. 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. @@ -40,19 +40,6 @@ cobalt has an open API that you can use in your projects 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. Feel free to use the main API instance ([co.wuk.sh](https://co.wuk.sh/)) in your projects. -## 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. - -### Translation guidelines: -- 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 extremely formal language, leave it for big and classy tech companies. Use informal language wherever possible. -- You can (and should) rephrase sentences as long as they keep the same sense and send the same message as original. -- 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 ### Requirements - Node.js 18 or above @@ -77,7 +64,7 @@ sudo service nscd start ### Docker It's also possible to run cobalt via Docker. I *highly* recommend using Docker compose. -Check out the [example compose file](https://github.com/wukko/cobalt/blob/current/docker-compose.yml.example) and alter it for your needs. +Check out the [example compose file](https://github.com/wukko/cobalt/blob/current/docker-compose.example.yml) and alter it for your needs. ## Disclaimer cobalt is my passion project, so update schedule depends solely on my free time, motivation, and mood.