README.md
branchENGINE-237
changeset 2008 f93bf1fac875
parent 1993 efaeadf3e6f0
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.md	Mon Aug 28 14:32:46 2017 +0200
     1.3 @@ -0,0 +1,60 @@
     1.4 +<!-- Copyright 2015-2017, pEp foundation, Switzerland
     1.5 +This file is part of the pEp Engine
     1.6 +This file may be used under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License
     1.7 +See CC_BY-SA.txt -->
     1.8 +
     1.9 +# What is the p≡p Engine?
    1.10 +The p≡p Engine is a Free Software library encapsulating implementations of:
    1.11 +
    1.12 +- Key Management
    1.13 +
    1.14 +  Key Management in the p≡p Engine is based on GnuPG key chains (NetPGP on iOS).
    1.15 +  Keys are stored in an OpenPGP-compatible format, and can be used for different crypto implementations.
    1.16 +
    1.17 +- Trust Rating
    1.18 +
    1.19 +  The p≡p Engine sports a two phase trust rating system for messages:
    1.20 +  In phase one a rating is derived based on channel, crypto and key security.
    1.21 +  This is named "comm\_types".
    1.22 +  In phase two these ratings are mapped to user-representable values mimicking the semantics of a traffic light.
    1.23 +
    1.24 +- Abstract Crypto API
    1.25 +
    1.26 +  The Abstract Crypto API provides functions to encrypt and decrypt data or full messages, without requiring an application programmer to understand the different applied formats and standards.
    1.27 +
    1.28 +- Message Transports
    1.29 +
    1.30 +  The p≡p Engine will sport a growing list of message transports, to support any widespread text-based messaging system such as E-Mail, SMS, XMPP and many more.
    1.31 +
    1.32 +The p≡p Engine is written in C99 and is expected to run on any platform that conforms to the SUS/POSIX specification.
    1.33 +Selected non-SUS platforms are supported as well (such as Microsoft Windows).
    1.34 +
    1.35 +# How can I use the p≡p Engine?
    1.36 +Build instructions can be found in the "doc/" subfolder in this repository.
    1.37 +The p≡p Engine is not meant to be used in application code directly.
    1.38 +Instead, the p≡p Engine is meant to be used in conjunction with a so-called "adapter".
    1.39 +An adapter provides an API in a programming language that best accomodates developers in their respective software development ecosystem.
    1.40 +So, for example, a Java Native Interface adapter exists for development of apps for the Android mobile operating system, or a .NET adapter exists for development of applications on Microsoft Windows.
    1.41 +Various adapters are also available at the link provided for the p≡p Engine's code above.
    1.42 +
    1.43 +# What is the current state of the project?
    1.44 +The p≡p Engine is production-ready.
    1.45 +It is under active development by several full-time employees of the p≡p foundation and its partner organizations.
    1.46 +The most recent version of the source code can be obtained here: <https://cacert.pep.foundation/dev>.
    1.47 +This is the only offical way to obtain a copy of the source code.
    1.48 +
    1.49 +# I would like to contribute to the p≡p Engine or a realated project, where do I start?
    1.50 +First of all, excellent!
    1.51 +We'd love to dicuss this opportunity further with you.
    1.52 +Please contact the upstream developers to get started.
    1.53 +See the [Contact](#contact) section.
    1.54 +
    1.55 +# Legal notes
    1.56 +The p≡p Engine is Copyright 2015-2017 by p≡p foundation, Switzerland.
    1.57 +The source code of the p≡p Engine is licensed under the terms of the GNU General Public License version 3.
    1.58 +Accompanying documentation is licensed under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) License.
    1.59 +Each file includes a notice near its beginning, that indicates the applicable license.
    1.60 +If you wish to license the p≡p Engine under different terms, please contact <mailto:council@pep.foundation>.
    1.61 +
    1.62 +# Contact
    1.63 +The p≡p foundation and the developers of the p≡p Engine can be reached as detailed here: <https://pep.foundation/contact-us/index.html>.