README
======

Documentation at https://privly-safari.readthedocs.org

.. image:: https://travis-ci.org/sammyshj/privly-safari.svg?branch=master
    :target: https://travis-ci.org/sammyshj/privly-safari

.. image:: https://coveralls.io/repos/sammyshj/privly-safari/badge.png
    :target: https://coveralls.io/r/sammyshj/privly-safari


About
-----

Privly is a developing set of browser extensions for protecting content
wherever it is posted on the internet. This extension allows users to
view content on any website, without the host site being able to read
the content. For more information on what Privly is, `read about
us <https://priv.ly/pages/about>`__.

Development Status
------------------

**Pre-alpha Version**

About this Extension
--------------------

This extension currently supports:

-  Locally served posting and injectable applications.
-  All the implemented `Injectable
   Applications <https://github.com/privly/privly-organization/wiki/Injectable-Applications>`__
   of the content server.

Installing/Testing/Submitting Bugs
----------------------------------

The installation instructions are found at `Safari Extension Development
Installation <https://priv.ly/pages/develop.html#SafariExtension>`__.

Extension integration test cases are found at
`test.privly.org <http://test.privly.org>`__. If you have discovered a
bug, only `open a public
issue <https://github.com/privly/privly-safari/issues/new>`__ on GitHub
if it could not possibly be a security related bug. If the bug affects
the security of the system, please report it privately by writing an
email to privly@privly.org. We will then fix the bug and follow a
process of responsible disclosure.

There are also unit and Selenium tests, which are found in the
privly-application git submodule.

Developer Documentation
-----------------------

Discussion of system concepts and high level processes are found in the
`central wiki <https://github.com/privly/privly-organization/wiki>`__.
If you want to develop an injectable application, look in the
``privly-applications`` folder.

Resources
---------

| `Foundation Home <http://www.privly.org>`__
| `Privly Project Repository List <https://github.com/privly>`__
| `Development Mailing List <http://groups.google.com/group/privly>`__
| `Testing Mailing List <http://groups.google.com/group/privly-test>`__
| `Announcement Mailing
  List <http://groups.google.com/group/privly-announce>`__
| `Central Wiki <https://github.com/privly/privly-organization/wiki>`__
| `Submit a Bug <http://www.privly.org/content/bug-report>`__
| `IRC <http://www.privly.org/content/irc>`__
| `Production Content Server <https://privlyalpha.org>`__
| `Development Content Server <https://dev.privly.org>`__
| `Download Extension <https://priv.ly/pages/download>`__

Contacts
--------

| **Email**:
| Community [the 'at' sign] privly.org

| **Mail**:
| Privly
| PO Box 79
| Corvallis, OR 97339

| **IRC**:
| Contact the Nick "`smcgregor <https://github.com/smcgregor>`__\ " on
  irc.freenode.net #privly
| Contact the Nick "`sambuddhabasu1 <https://github.com/sammyshj>`__\ "
  on irc.freenode.net #privly

| **Bug**:
| If you open a bug on this repository, you'll get someone's attention