Skip to content

Commit

Permalink
Improves readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pedropalau committed Jun 30, 2020
1 parent 44b96a4 commit 0f598d9
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# Wahay - easy-to-use, secure and decentralized conference calls
<p>
<a href="https://wahay.org/" target="_blank" rel="noopener noreferrer">
<h1>Wahay</h1>
</a><br>
An easy-to-use, secure and decentralized conference call application.
</p>

------

[Wahay](https://wahay.org) is an application that allows you to easily host and participate in conference calls, without the need for any
centralized servers or services. We are building a voice call application that is meant to be as easy-to-use as possible, while still
providing extremely high security and privacy out of the box.

In order to do this, we use [Tor](https://torproject.org) Onion Services in order to communicate between the end-points, and we use the
[Mumble](https://www.mumble.info) protocol for the actual voice communication. We are doing extensive user testing in order to ensure that
the usability of the application is as good as possible.
In order to do this, we use [Tor](https://torproject.org) Onion Services in order to communicate between the end-points, and we use the [Mumble](https://www.mumble.info) protocol for the actual voice communication. We are doing extensive user testing in order to ensure that the usability of the application is as good as possible.

## Documentation

## Installing
For full documentation, visit [wahay.org](https://wahay.org/documentation/index.html).

For end-users, please refer to installation instructions on the [website](https://wahay.org). We provide several different options for
installation there. If you are a developer, installing the application should be as easy as cloning the repository and running `make build`.
## Installing

For end-users, please refer to installation instructions on the [website](https://wahay.org/documentation/getting-started/installation/). We provide several different options for installation there. If you are a developer, installing the application should be as easy as cloning the repository and running `make build`.

## Security warning

Expand All @@ -22,21 +28,23 @@ of the code, and you should currently not use this for anything sensitive.

## Language

The language to be used is the same configured under LANG environment variable.
Example: export LANG="en_US.utf8"
The language to be used is the same configured under `LANG` environment variable.

Example:

```bash
$ export LANG="en_US.utf8"
```

## Compatibility

The current version of Wahay is compatible with all major Linux distributions. It is possible that the application can run on OS X or
Windows, but at this moment we have not tested this. We are planning on adding official OS X and Windows compatibility in the near future.


## About the developers

Wahay is developed by the NGO [Centro de Autonomía Digital](https://autonomia.digital), based in Quito, Ecuador.



## License

Wahay is licensed under the GPL version 3.
Wahay is licensed under the [GPL version 3](https://www.gnu.org/licenses/gpl-3.0.html).

0 comments on commit 0f598d9

Please sign in to comment.