[tor-commits] [snowflake-mobile/master] Initial readme commit

[cohosh@xxxxxxxxxxxxxx]

commit 5430ae0d21270049a213baf3804135542a88d423
Author: Hashik Donthineni <HashikDonthineni@xxxxxxxxx>
Date:   Thu Jul 2 01:45:23 2020 +0530

    Initial readme commit
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..27f93b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+<center>  <h2>Snowflake Mobile</h2>  </center>
+<p  align="center">
+<img  width="100"  height="100"  src="https://gitweb.torproject.org/pluggable-transports/snowflake-webext.git/plain/static/assets/status-on.svg";>
+</p>
+
+> Implementing Snowflake proxy on the Android platform as a native
+> application for volunteer users to contribute as a relay and help
+> circumvent censorship.
+  
+ 
+
+## Building and Running
+The build process is similar to any other Android application. \
+To be able to test broker API, simulate a client, you can use [Snowbox](https://github.com/cohosh/snowbox). It is a Docker container that is used to fulfill the said tasks and makes development smooth.
+
+
+## Contribution
+Download Android studio, import the project, set-up Snowbox, you are good to go! to feel comfortable around the code base I strongly suggest taking a lookg at the [Wiki](https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake-mobile/-/wikis/home).
+
+## Contact  
+You can use [Tor OFTC IRC](https://www.torproject.org/contact/) to contact the people at Tor and get to know the dev team.  
+If you want to contact me exclusively you can email me at HashikDonthineni(@)Gmail(dot)com \
+<sub> <sub>Quoted from wiki</sub></sub> 
+



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits