Brendan Abolivier hace 8 años
padre
commit
cfd089bce1
Se han modificado 1 ficheros con 21 adiciones y 0 borrados
  1. 21
    0
      README.md

+ 21
- 0
README.md Ver fichero

@@ -0,0 +1,21 @@
1
+# Collateral Freedom
2
+Extension for Chrome and Chromium
3
+
4
+This extension has been developped by [Brendan Abolivier](https://github.com/babolivier) and [Clément Salaün](https://github.com/altitude)
5
+during the **Collateral Freedom** hackaton organised by [Reporters Without Borders](https://en.rsf.org/) and [An Daol Vras](http://lacantine-brest.net/).
6
+
7
+Its goal is to ease the access to the **Collateral Freedom** initiative, which replicates websites around the Web in order to make them available
8
+for everyone, including in the contries they're censored in.
9
+
10
+## Howto
11
+
12
+The extension will add an icon next to your address bar. Most of the time, this icon will stay unchanged, and clicking it will show
13
+a message saying that no replication of the current tab's website has been set up by RWB.
14
+
15
+When connecting (or trying to connect) to a website for which a replicated version has been set up by RWB, the extension's icon will turn
16
+red. Clicking on them will open a pop-up page with a button, which, if you click it, will bring you to the replicated website.
17
+
18
+## Contribute
19
+
20
+If you want to contribute, please feel free to do so. The first thing to do may be to check [the repo's issues](https://github.com/babolivier/collateral-freedom/issues).
21
+When you've found something to contribute on, just fork this repository, make your changes, and send a pull-request.