Browse Source

Reformat README.

pull/3202/head
TheGoddessInari 6 years ago
parent
commit
047a96c98a
No known key found for this signature in database
GPG Key ID: 1209B1B7632D69A
  1. 91
      .vscode/settings.json
  2. 106
      README.md

91
.vscode/settings.json vendored

@ -1,20 +1,73 @@
{ {
"eslint.enable": true, "eslint.enable": true,
"search.exclude": { "search.exclude": {
"**/node_modules": true, "**/node_modules": true,
"**/bower_components": true, "**/bower_components": true,
"ext": true, "ext": true,
"**/.sencha": true, "**/.sencha": true,
"**/*.jsonp": true, "**/*.jsonp": true,
"**/sencha-error-*.log": true "**/sencha-error-*.log": true
}, },
"es6-css-minify.css": { "minify.js": {
"level": 2 "mangle": false,
}, "compress": {
"es6-css-minify.js": { "sequences": true,
"output": { "properties": true,
"ecma": 6 "dead_code": true,
} "drop_debugger": true,
}, "unsafe": false,
"es6-css-minify.minifyOnSave": "exists", "unsafe_comps": false,
} "conditionals": true,
"comparisons": true,
"evaluate": true,
"booleans": true,
"loops": true,
"unused": true,
"hoist_funs": true,
"keep_fargs": true,
"keep_fnames": false,
"hoist_vars": false,
"if_return": true,
"join_vars": true,
"collapse_vars": false,
"reduce_vars": false,
"side_effects": true,
"pure_getters": false,
"pure_funcs": null,
"negate_iife": false,
"drop_console": false,
"passes": 1,
"global_defs": {}
},
"output": {
"ascii_only": false,
"inline_script": false,
"max_line_len": 32000,
"braces": false,
"semicolons": true,
"comments": false,
"shebang": true,
"preamble": null,
"quote_style": "best"
}
},
"prettier.eslintIntegration": true,
"prettier.singleQuote": true,
"prettier.stylelintIntegration": true,
"markdown.extension.toc.githubCompatibility": true,
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"editor.defaultFormatter": "yzhang.markdown-all-in-one"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}

106
README.md

@ -1,54 +1,50 @@
<h1 align="center"> # Rambox-OS, soon to be renamed to Hamsket. <!-- omit in toc -->
<br>
<a href="https://github.com/TheGoddessInari/rambox"><img src="./resources/Icon.png" width="256px" alt="Rambox-OS"></a>
<br>
Rambox-OS, soon to be renamed to Hamsket.
<br>
<br>
</h1>
<h4 align="center">Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.</h4>
<p align="center">
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html" target="_blank"><img src="https://img.shields.io/github/license/TheGoddessInari/rambox.svg" alt="GNU GPL v3"></a>
<a href="https://gitter.im/TheGoddessInari/rambox" target="_blank"><img src="https://img.shields.io/gitter/room/TheGoddessInari/rambox.svg" alt="Gitter"></a>
<a href="https://github.com/TheGoddessInari/rambox/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/TheGoddessInari/rambox.svg" alt="Release"></a>
</p>
<p align="center"> <p align="center">
<a href="https://dev.azure.com/TheGoddessInari/rambox/_build?definitionId=2" target="_blank"><img src="https://img.shields.io/azure-devops/build/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/2.svg?logo=azure-devops"></a> <a href="https://github.com/TheGoddessInari/rambox"><img src="./resources/Icon.png" width="256px" alt="Rambox-OS"></a>
<a href="https://dev.azure.com/TheGoddessInari/rambox/_release?definitionId=1" target="_blank"><img src="https://img.shields.io/azure-devops/release/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/1/1.svg?logo=azure-devops"></a>
<a href="https://david-dm.org/TheGoddessInari/rambox?path=app" title="Dependency status"><img src="https://img.shields.io/david/TheGoddessInari/rambox.svg?path=app"/></a>
<a href="https://david-dm.org/TheGoddessInari/rambox?type=dev" title="devDependency status"><img src="https://img.shields.io/david/dev/TheGoddessInari/rambox.svg"/></a>
</p> </p>
<h5 align="center">Nightly build artifacts are available in Windows
(<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS.Setup.0.5.18.exe" target="_blank">Win64</a>), Mac #### Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one. <!-- omit in toc -->
(<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS-0.5.18.dmg" target="_blank">DMG</a> /
<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS-0.5.18-mac.zip" target="_blank">App</a>) and Linux [![GNU GPL v3][license]](https://www.gnu.org/licenses/gpl-3.0.en.html)
(<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS.0.5.18.AppImage" target="_blank">AppImage64</a> / [![Gitter][gitter]](https://gitter.im/TheGoddessInari/rambox)
<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-0.5.18.x86_64.rpm" target="_blank">RPM64</a> / [![Release][release]](https://github.com/TheGoddessInari/rambox/releases/latest)
<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox_0.5.18_amd64.deb" target="_blank">DEB64</a> /
<a href="https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-0.5.18.tar.gz" target="_blank">Tarball64</a>) packaging flavors.</h5> [![DevOps Build][devops-build]](https://dev.azure.com/TheGoddessInari/rambox/_build?definitionId=2)
[![DevOps Deployment][devops-deploy]](https://dev.azure.com/TheGoddessInari/rambox/_release?definitionId=1)
<h6 align="center">Logo designed by <a href="http://andyur.com/" target="_blank">Andriy Yurchenko</a></h6> [![Dependencies][dependencies]](https://david-dm.org/TheGoddessInari/rambox?path=app)
<h6 align="center">Original rambox by <a href="https://github.com/saenzramiro" target="_blank">Ramiro Saenz</a></h6> [![DevDependencies][dev-dependencies]](https://david-dm.org/TheGoddessInari/rambox?type=dev)
[license]: https://img.shields.io/github/license/TheGoddessInari/rambox.svg
[gitter]: https://img.shields.io/gitter/room/TheGoddessInari/rambox.svg
[release]: https://img.shields.io/github/release/TheGoddessInari/rambox.svg
[devops-build]: https://img.shields.io/azure-devops/build/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/2.svg?logo=azure-devops
[devops-deploy]: https://img.shields.io/azure-devops/release/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/1/1.svg?logo=azure-devops
[dependencies]: https://img.shields.io/david/TheGoddessInari/rambox.svg?path=app
[dev-dependencies]: https://img.shields.io/david/dev/TheGoddessInari/rambox.svg
##### Nightly build artifacts are available in Windows ([Win64](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS.Setup.0.5.18.exe)), Mac ([DMG](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS-0.5.18.dmg) / [App](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS-0.5.18-mac.zip)), and Linux ([AppImage64](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-OS.0.5.18.AppImage) / [RPM64](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-0.5.18.x86_64.rpm) / [DEB64](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox_0.5.18_amd64.deb) / [Tarball64](https://github.com/TheGoddessInari/rambox/releases/download/nightly/Rambox-0.5.18.tar.gz)) packaging flavors. <!-- omit in toc -->
###### Logo designed by [Andriy Yurchenko](http://andyur.com/). <!-- omit in toc -->
###### Original rambox by [Ramiro Saenz](https://github.com/saenzramiro). <!-- omit in toc -->
---------- ----------
## Table of Contents ## Table of Contents
- [Screenshot](#screenshot) - [Table of Contents](#Table-of-Contents)
- [Services available - 97](#services-available---97) - [Screenshot](#Screenshot)
- [Features](#features) - [Services available - 95](#Services-available---95)
- [Privacy](#privacy) - [Features](#Features)
- [Donations](#donations) - [Privacy](#Privacy)
- [Translations](#translations) - [Donations](#Donations)
- [Compiling](#compiling) - [Compiling](#Compiling)
- [To Do](#to-do) - [Contributing](#Contributing)
- [Contributing](#contributing) - [Quickstart](#Quickstart)
- [Quickstart](#quickstart) - [Disclosure](#Disclosure)
- [Disclosure](#disclosure) - [License](#License)
- [Licence](#licence)
---------- ----------
@ -58,7 +54,7 @@
---------- ----------
## Services available - 97 ## Services available - 95
<img width="80" align="left" src="./resources/icons/whatsapp.png" alt="WhatsApp" title="WhatsApp"> <img width="80" align="left" src="./resources/icons/whatsapp.png" alt="WhatsApp" title="WhatsApp">
<img width="80" align="left" src="./resources/icons/messenger.png" alt="Messenger" title="Messenger"> <img width="80" align="left" src="./resources/icons/messenger.png" alt="Messenger" title="Messenger">
@ -209,13 +205,13 @@ Auth0 is disabled pending name change and rewrite of the functionality to best p
Keep in mind, I'm not pushing this. I'll do my best regardless. Keep in mind, I'm not pushing this. I'll do my best regardless.
| Type | URL/Wallet | | Type | URL/Wallet |
|--------------------|:------------------------------------------------------------------------------------------:| | ------------ | :----------------------------------------------: |
| GoFundMe | https://www.gofundme.com/rambox-os | | GoFundMe | <https://www.gofundme.com/rambox-os> |
| Bitcoin | ```36SxZeQ5dA7Dn6pSmYWcvvmnkEeh8LdgmJ``` | | Bitcoin | ```36SxZeQ5dA7Dn6pSmYWcvvmnkEeh8LdgmJ``` |
| Bitcoin Cash | ```qqslp2vuamhmsp59u49dq89kwky2yj23nqmjr4mdgj``` | | Bitcoin Cash | ```qqslp2vuamhmsp59u49dq89kwky2yj23nqmjr4mdgj``` |
| Ethereum | ```0xa085d5F736f2D7D210261879e183e5bf870Eae5f``` | | Ethereum | ```0xa085d5F736f2D7D210261879e183e5bf870Eae5f``` |
| Litecoin | ```MKzytRHYHQTS3qrq2zCggEzSNG3HTbBXZL``` | | Litecoin | ```MKzytRHYHQTS3qrq2zCggEzSNG3HTbBXZL``` |
---------- ----------
@ -256,7 +252,7 @@ Want to report a bug, request a feature, contribute to or translate Rambox? We n
---------- ----------
### Quickstart ## Quickstart
```shell ```shell
git clone https://github.com/TheGoddessInari/rambox.git git clone https://github.com/TheGoddessInari/rambox.git
@ -269,14 +265,14 @@ See [Contributing.md](./CONTRIBUTING.md) for more detailed information about get
---------- ----------
### Disclosure ## Disclosure
Rambox-OS is not affiliated with any of the messaging apps offered. Rambox-OS is not affiliated with any of the messaging apps offered.
---------- ----------
### License ## License
[GNU GPL v3](./LICENSE) [GNU GPL v3](./LICENSE)
---------- ----------

Loading…
Cancel
Save