Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history 
• Remove software badges from Readme.md (show them in Repos.md instead).
• Add documentation about community-maintained repositories.
• Update FAQ accordingly to the change mentioned above.
  • Loading branch information
@SpacingBat3
SpacingBat3 committed Sep 13, 2022
1 parent f83f93a commit e6684b5
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 26 deletions.
6 changes: 5 additions & 1 deletion docs/FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ grouped in tables by platforms:

<div align='right'><sup>* Platforms deprecated by Electron. </sup></div></div>

There's also a list of community-maintained WebCord packages in [`Repos.md`].

### 2. Image/video/content does not load properly, is there anything I can do about it?
Yes, this is probably an issue due to Content Security Policy header not
including all URLs that are allowed to load. You can disable it [in Settings](./Settings.md)
Expand Down Expand Up @@ -98,4 +100,6 @@ Also, you can actually reuse the Electron binaries across different applications
Electron-based applications that does not depend on any specific Electron
version/binary. This practise will save the disk space and other resources,
since there's no need to run simultaneously multiple Electron binaries with
different Chromium engine versions.
different Chromium engine versions.

[`Repos.md`]: ./Repos.md "List of community-maintained software repositories providing WebCord."
53 changes: 28 additions & 25 deletions docs/Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@

# WebCord

[![Build][badge2]][badge2url] [![Weblate badge][badge6]][badge6url]
[![GitHub downloads][badge1]][badge1url] [![Pi-Apps badge][badge3]][pi-apps]
[![Pi-Ware badge][badge5]][pi-ware] [![Unofficial APT repository][badge4]][debian-repo]
[![Build][badge2]][badge2url] [![Weblate badge][l10nbadge]][l10n]
[![GitHub downloads][dlbadge]][downloads]


A Discord and [Fosscord] client implemented directly without [Discord API][discordapi].
Expand All @@ -42,18 +41,24 @@ to prevent distinguishing it from the real Chrome/Chromium browsers.

- 🛡️ **Follows the best security practises**

Built on Electron and Chromium, WebCord is consistently secure on all platforms
and does not depend on *native* browser engines' security. Moreover Chrome (and
because of this – Chromium) has a good [vulnerability rewards program][chromiumbounty],
which is **probably** one of the most popular programs from all of the browsers.
It should also be said Electron does care about the remote content security – it
has a complex process model which sandboxes (at least) the browser scripts from
Node.js. And with the restrictive TypeScript and ESlint policy, most simple bugs
in the code, including those affecting the app security, are eliminated even
before they will go into the production. WebCord also tries to follow practises
from the [Electron#Security]. It has also a few securities known from the
browsers, like an `alert`/`prompt` dialog spam prevention in case Discord would
begin to behave maliciously.
WebCord cares a lot about your security. Being fully written in TypeScript, it
brings the power of static types to help detecting common bugs without the need
of testing the app at runtime. All of this is hardened by ESLint, which forbidds
some TypeScript practises like the use of `any` type and enforces some cosmetic
aspects of the code to keep it more consistent.

Unlike to official Discord client, WebCord's policy about Electron also makes it
to use the latest major release currently supported and available at the package
time. This makes WebCord use more up-to-date Electron releases with more recent
Chromium engine.

Built on top Electron and Chromium, WebCord's security is also highly dependant
from Chrome's [vulnerability rewards program][chromiumbounty], which is probably
one of the most known programs like this when comparing to different popular
browser engines choices. Electron is also well-prepared for loading remote
content, using their process model to the advantage and different Chromium
sandboxing techniques to split Node.js from browser scripts. WebCord also tries
its best to follow practises from the [Electron#Security].

- 🛠️ **Customizable**

Expand All @@ -78,6 +83,7 @@ You may also read [Features](Features.md) to know which features have been imple
It is strongly advised to read the [application license](../LICENSE) as well.

- [List of WebCord's features](Features.md)
- [Community maintained repositories providing WebCord](Community.md)
- [Frequently Asked Questions](FAQ.md)
- *[Which file I should download?](FAQ.md#1-which-file-i-should-download)*
- *[Content does not load properly...](FAQ.md#2-imagevideocontent-does-not-load-properly-is-there-anything-i-can-do-about-it)*
Expand Down Expand Up @@ -167,18 +173,15 @@ Please take a look at [`Contributing.md`](./Contributing.md) – it describes mo
about ways of giving your help to improve quality of WebCord. And for some tasks
you don't even need to be familiar with programming at all!

[badge1]: https://img.shields.io/github/downloads/SpacingBat3/WebCord/total.svg?label=Downloads&color=%236586B3
[badge1url]: https://github.com/SpacingBat3/WebCord/releases "Releases"
[dlbadge]: https://img.shields.io/github/downloads/SpacingBat3/WebCord/total.svg?label=Downloads&color=%236586B3
[downloads]: https://github.com/SpacingBat3/WebCord/releases "Releases"
[badge2]: https://img.shields.io/github/workflow/status/SpacingBat3/WebCord/Run%20tests?label=Build&logo=github
[badge2url]: https://github.com/SpacingBat3/WebCord/actions/workflows/build.yml "Build state"
[badge3]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-pi-apps-badge-sypgxsowx4mj.runkit.sh%2F
[pi-apps]: https://github.com/Botspot/pi-apps "An app center with open source software for Raspberry Pi OS. (GitHub)"
[badge4]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-debian-badge-toklg87kjpyo.runkit.sh%2F
[pi-ware]: https://github.com/piware14/pi-ware "An alternative store to Pi-Apps. (GitHub)"
[badge5]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-pi-apps-badge-sypgxsowx4mj.runkit.sh%2F%3Fbadge%3Dpi-ware&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAQAAAAAYLlVAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAHdElNRQfmAxEVIguJQeYmAAAHQ0lEQVRo3rWZW6hW1RbHf2Ou9W23be+Wt05eCLO9jbKTdpGjp6A7dCGCoAsFPXV5KsJuT3GIrKcegh56CB+CoBMRBIdSOBRRaUnXXYRaZgmxNS3Z6qffmrOHNdda87Y+vx05P3B/fmvMOW7/MeYYY8k+Q70Edxn7i/F+nToNmD40eb8t4UoxNwFtG/M2mrw5LNQlFiHUV5IMp0aTVySqRevTtQy6sYCwi51kaEDqT2OJQR3Sj51BMDWdJuNfnIUmB0PG5zzT5/C/U+/q7xm8xAJqDKgWwtO9hFwCZvq0s5T6G0Dus+9wE0vRfWMhdWiM9hRCDMJXbK0FESAXj6zDbaylSDDwAzR2kdQsmgzRALgK84w32eaA0YQWgIICXePe1MwkiHAZgCYlWPPElHlAaoOUjxTZlHxqPFHiJOQ7ILZb7v+s2cN0D4ihvj5LyJnBCNMZQtXY8V1k6n9jx5kqCio7dNlcReaAK2eEWSxkOasZYzGdFvHb4JxX8lV/J6fEHuCA3TuNRVzK9axhxMK4cUl7LFl1Cy/0prIEUAjQ4yf28j8u4y7WkidCOb6QpRTAMIcLHdIQRKn/lUvTZZIjTHISQQGTbGUnN3MPZ6O9s9Khm5f6b2QdfkaQaGNKAMNJjnGIvXzOp/xIl4yMw2zhSx7lnwnj+/A0VRh26CTNe2q3CHAOF3EjE2znLT7jBArYyZM8wb/rgqXtpLypWIx3rBu7g9DAQm5hI+/wKj+jyPiJZxnmslqEUJ0q7ziJ039YbTKENBLRlHgomM2dPM8lGECxj83sIguc61tPVb5oLhNxGBiHXUNjHBqDm1w1hov5D5ejAcV3vMyRVvcZQIknj59KwxTqi1TeZxk5yhOiYDlPcL6tr7bxrlcLhaGYl8baydvB4yaJzONe5mAQjrKF/YiNe0HIGWEZoyxnyLGFZiUP8xR/IBznv1zJvGSdUV/Hih94vSVfaZZyO3MxCCd4l2+iy6rDPDZwN6s8V2zkel5HyBhnOze0RkJdi2XkZMmPstKaFirNBG/wKB9ayJbR0uFW5mOA43zASdJXkamioFkZHTp0yB17mMQ3sa7QaISM3TzH96ganprzWG1xMM7hoNL2MOAWU9N4gJVohIIt7HCKVZdOs4Y7yADNfrbyLULGLl7jabJazOlcwPuAMMEEZ1kUhKVaUJLlrLMlmWYb22tdQ1ws49b612vYxDgK4SN+YZl1gSFjKTkaYZJfWQ1JC0Qu0PTo0aNIQqa533v1ZyXXWOv8xq9eSptpAdvjd8KLrlbZRCzEItbPBiF4Gn2EoVosnayMTVTmNstrTn0fpaDXrKzGx27ewyBo5rDAi/ejlrFiuOUUaa+/0rdXlQMPsAPBUPAjbzKOAgyXc46XsPfRQ2GYzsKEgk494BvXOLk+vTI+5SGgLEgKFFCwgjttRVjuPc7XNgWfyZJkJjSYqj2PNfdvrVCgwtaOZR41aFawiTHLpkxZu/nKWmaU+fVlHioWuSBGQ9PruFS6/qaYy3ruY7XXF/V4mwkEGGIDwwkYmkoAk2CbruKbrfM513pwDitZxyjTbASU7BUf8Y510ihX1L1WfObATYBrA806nrHm75BjrEWqskWxhxc5iAKGuJ0FwUXuOjeXlvBIOaXBR8awDcMwxg0Z+9hs/V9wNTd6RUtkgcG7AX9ok3aSoBjnBT5BAZpVPMjM1plD1J6ntK5I2y1lagrFEd7jFfZY9ot5jPPQTvccK5S3HTvICKpKSwqh4CCf8RYfc9yyX8Qm1ntlTngPmKY57W/ykjwlf48uJzjED3zBJ+ziGAqFwTDKI6x3GKdnbVF7nta67VZQ/J8tHOU3DtOlnC0YCmZwHfezwitDY8yU7ktaICROt1cG2M8OWwWVZjeMsIY72MCw5/s+7Tl/aYm9L8QmWw0MsZi1XMtaZqGdvOC7L0rFqVA69WSsuq46zGQGs1nCuYyxirMZQttWv52pyyuqB9Ls0qvgKsaYzSxm2BGNpghUGKg9b8t8MXnzraRaxGKwqTgsOg1tU2aXVzIRpbfFCdVvvd1CrmnGwslZOL5SqY4tJpUgOfnHSEuc+IVo2haKPiHiH9g2shcnLEPgGdpBbZr2PD72VJVwdXg8+2wqQrexb1dLScuDQcbUjW9dIVLpp097njaqL4BCYbuYU9ipEUFaaFx72DDsf/cJJ9lLD43wO91Id1dX44EuPilVQ0SJKHx/JhzgcUumOVQ36+KwDadFRG4wpN4e2rLcRAL49tAc9Izmu8v1s+Cj339/kFrSjOnKyq5wdNAULfEdNq7hjLyZLaUyR3lTVNPkvGQ/lzEApnFGTf4PxoIRW3VUwZKIrd9yxS83Kpq5XIBCGGZm6cqfjUHocsxuHqFjyY/R9bDsajhkBQ2d4SOAiAa6tmRTtq6W8uV1w8i/QuKePh5pxrNwiTAgEbXTGbmbQ3OmAqct5aaWRDQNxkpF8xRpel7wV2jSo3/Xvn8CQ2Xv9Q5W5tAAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDMtMTdUMjE6MzQ6MTErMDA6MDA96cqUAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAzLTE3VDIxOjM0OjExKzAwOjAwTLRyKAAAAABJRU5ErkJggg==
[debian-repo]: https://itai-nelken.github.io/Webcord_debian-repo/ "Unofficial Debian repository (Homepage)"
[badge6]: https://hosted.weblate.org/widgets/webcord/-/svg-badge.svg
[badge6url]: https://hosted.weblate.org/engage/webcord/ "Help at WebCord's localization"



[l10nbadge]: https://hosted.weblate.org/widgets/webcord/-/svg-badge.svg
[l10n]: https://hosted.weblate.org/engage/webcord/ "Help at WebCord's localization"
[Sentry]: https://sentry.io "Application Monitoring and Error Tracking Software"
[Discord-Electron]: https://github.com/GyozaGuy/Discord-Electron "An Electron Discord app designed for use on Linux systems."
[npm-docs]: https://docs.npmjs.com/cli/v7/configuring-npm/package-json#people-fields-author-contributors "People Fields | NPM Documentation"
Expand Down
30 changes: 30 additions & 0 deletions docs/Repos.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# List of community-maintained software repositories providing WebCord.

Most of outside WebCord builds are actually provided by the community!
This list includes known repositories, with their maintainers.

| Name | Maintainer | Platform | Homepage | Badge (WebCord version) |
| ------------------ | ------------- | ------------------ | ---------------------------- | ------------------------------------------------- |
| Pi-Apps | [Botspot] | RPiOS (Debian,ARM) | [pi-apps.io][pi-apps-home] | [![Pi-Apps][pi-apps-badge]][pi-apps] |
| Pi-Ware | [oxmc] | Linux (ARM) | [pi-ware.ml][pi-ware-home] | [![Pi-Ware][pi-ware-badge]][pi-ware] |
| Debian repository | [Itai] | Debian (x86,ARM) | [itai-nelken.github.io][deb] | [![Unofficial APT repository][debian-badge]][deb] |
| Flathub repository | [Multiple] | Linux (x86,ARM) | [(FlatHub page)][flathub] | (None, see [website][flathub] for version) |
| Scoop/Extras | [lukesampson] | Windows (x86) | [scoop.sh] | (None) |

<!-- Gibberish below: -->

[pi-apps]: https://github.com/Botspot/pi-apps "An app center with open source software for Raspberry Pi OS. (GitHub)"
[pi-apps-home]: https://pi-apps.io/ "An app center with open source software for Raspberry Pi OS. (Homepage)"
[pi-apps-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-pi-apps-badge-sypgxsowx4mj.runkit.sh%2F
[pi-ware]: https://github.com/piware14/pi-ware "An alternative store to Pi-Apps. (GitHub)"
[pi-ware-home]: https://pi-ware.ml "An alternative store to Pi-Apps. (Homepage)"
[pi-ware-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-pi-apps-badge-sypgxsowx4mj.runkit.sh%2F%3Fbadge%3Dpi-ware&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAQAAAAAYLlVAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAHdElNRQfmAxEVIguJQeYmAAAHQ0lEQVRo3rWZW6hW1RbHf2Ou9W23be+Wt05eCLO9jbKTdpGjp6A7dCGCoAsFPXV5KsJuT3GIrKcegh56CB+CoBMRBIdSOBRRaUnXXYRaZgmxNS3Z6qffmrOHNdda87Y+vx05P3B/fmvMOW7/MeYYY8k+Q70Edxn7i/F+nToNmD40eb8t4UoxNwFtG/M2mrw5LNQlFiHUV5IMp0aTVySqRevTtQy6sYCwi51kaEDqT2OJQR3Sj51BMDWdJuNfnIUmB0PG5zzT5/C/U+/q7xm8xAJqDKgWwtO9hFwCZvq0s5T6G0Dus+9wE0vRfWMhdWiM9hRCDMJXbK0FESAXj6zDbaylSDDwAzR2kdQsmgzRALgK84w32eaA0YQWgIICXePe1MwkiHAZgCYlWPPElHlAaoOUjxTZlHxqPFHiJOQ7ILZb7v+s2cN0D4ihvj5LyJnBCNMZQtXY8V1k6n9jx5kqCio7dNlcReaAK2eEWSxkOasZYzGdFvHb4JxX8lV/J6fEHuCA3TuNRVzK9axhxMK4cUl7LFl1Cy/0prIEUAjQ4yf28j8u4y7WkidCOb6QpRTAMIcLHdIQRKn/lUvTZZIjTHISQQGTbGUnN3MPZ6O9s9Khm5f6b2QdfkaQaGNKAMNJjnGIvXzOp/xIl4yMw2zhSx7lnwnj+/A0VRh26CTNe2q3CHAOF3EjE2znLT7jBArYyZM8wb/rgqXtpLypWIx3rBu7g9DAQm5hI+/wKj+jyPiJZxnmslqEUJ0q7ziJ039YbTKENBLRlHgomM2dPM8lGECxj83sIguc61tPVb5oLhNxGBiHXUNjHBqDm1w1hov5D5ejAcV3vMyRVvcZQIknj59KwxTqi1TeZxk5yhOiYDlPcL6tr7bxrlcLhaGYl8baydvB4yaJzONe5mAQjrKF/YiNe0HIGWEZoyxnyLGFZiUP8xR/IBznv1zJvGSdUV/Hih94vSVfaZZyO3MxCCd4l2+iy6rDPDZwN6s8V2zkel5HyBhnOze0RkJdi2XkZMmPstKaFirNBG/wKB9ayJbR0uFW5mOA43zASdJXkamioFkZHTp0yB17mMQ3sa7QaISM3TzH96ganprzWG1xMM7hoNL2MOAWU9N4gJVohIIt7HCKVZdOs4Y7yADNfrbyLULGLl7jabJazOlcwPuAMMEEZ1kUhKVaUJLlrLMlmWYb22tdQ1ws49b612vYxDgK4SN+YZl1gSFjKTkaYZJfWQ1JC0Qu0PTo0aNIQqa533v1ZyXXWOv8xq9eSptpAdvjd8KLrlbZRCzEItbPBiF4Gn2EoVosnayMTVTmNstrTn0fpaDXrKzGx27ewyBo5rDAi/ejlrFiuOUUaa+/0rdXlQMPsAPBUPAjbzKOAgyXc46XsPfRQ2GYzsKEgk494BvXOLk+vTI+5SGgLEgKFFCwgjttRVjuPc7XNgWfyZJkJjSYqj2PNfdvrVCgwtaOZR41aFawiTHLpkxZu/nKWmaU+fVlHioWuSBGQ9PruFS6/qaYy3ruY7XXF/V4mwkEGGIDwwkYmkoAk2CbruKbrfM513pwDitZxyjTbASU7BUf8Y510ihX1L1WfObATYBrA806nrHm75BjrEWqskWxhxc5iAKGuJ0FwUXuOjeXlvBIOaXBR8awDcMwxg0Z+9hs/V9wNTd6RUtkgcG7AX9ok3aSoBjnBT5BAZpVPMjM1plD1J6ntK5I2y1lagrFEd7jFfZY9ot5jPPQTvccK5S3HTvICKpKSwqh4CCf8RYfc9yyX8Qm1ntlTngPmKY57W/ykjwlf48uJzjED3zBJ+ziGAqFwTDKI6x3GKdnbVF7nta67VZQ/J8tHOU3DtOlnC0YCmZwHfezwitDY8yU7ktaICROt1cG2M8OWwWVZjeMsIY72MCw5/s+7Tl/aYm9L8QmWw0MsZi1XMtaZqGdvOC7L0rFqVA69WSsuq46zGQGs1nCuYyxirMZQttWv52pyyuqB9Ls0qvgKsaYzSxm2BGNpghUGKg9b8t8MXnzraRaxGKwqTgsOg1tU2aXVzIRpbfFCdVvvd1CrmnGwslZOL5SqY4tJpUgOfnHSEuc+IVo2haKPiHiH9g2shcnLEPgGdpBbZr2PD72VJVwdXg8+2wqQrexb1dLScuDQcbUjW9dIVLpp097njaqL4BCYbuYU9ipEUFaaFx72DDsf/cJJ9lLD43wO91Id1dX44EuPilVQ0SJKHx/JhzgcUumOVQ36+KwDadFRG4wpN4e2rLcRAL49tAc9Izmu8v1s+Cj339/kFrSjOnKyq5wdNAULfEdNq7hjLyZLaUyR3lTVNPkvGQ/lzEApnFGTf4PxoIRW3VUwZKIrd9yxS83Kpq5XIBCGGZm6cqfjUHocsxuHqFjyY/R9bDsajhkBQ2d4SOAiAa6tmRTtq6W8uV1w8i/QuKePh5pxrNwiTAgEbXTGbmbQ3OmAqct5aaWRDQNxkpF8xRpel7wV2jSo3/Xvn8CQ2Xv9Q5W5tAAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDMtMTdUMjE6MzQ6MTErMDA6MDA96cqUAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAzLTE3VDIxOjM0OjExKzAwOjAwTLRyKAAAAABJRU5ErkJggg==
[debian-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fwebcord-debian-badge-toklg87kjpyo.runkit.sh%2F
[deb]: https://itai-nelken.github.io/Webcord_debian-repo/ "Unofficial Debian repository (Homepage)"
[Multiple]: https://github.com/flathub/io.github.spacingbat3.webcord/graphs/contributors
[flathub]: https://flathub.org/apps/details/io.github.spacingbat3.webcord "Community-maintained Flathub repository."
[Botspot]: https://github.com/Botspot
[Itai]: https://github.com/Itai-Nelken
[oxmc]: https://github.com/oxmc
[lukesampson]: https://github.com/lukesampson
[scoop.sh]: https://scoop.sh/

0 comments on commit e6684b5

Please sign in to comment.