Added first draft of readme.

This commit is contained in:
Clinton Alexander 2016-11-21 15:18:28 +00:00 committed by Clinton Alexander
parent 1b943951f0
commit 2ba07839bd

View File

@ -2,21 +2,45 @@
# Corda
Corda is a decentralised database system in which nodes trust each other as little as possible. This reference
implementation is not yet complete or offering backwards compatibility, but should be suitable for small experiments
and exploration of the underlying ideas.
Corda is a decentralised database system in which nodes trust each other as little as possible.
## Features
* A P2P network of nodes.
* Smart contracts.
* Protocol framework.
* UTXO notary infrastructure with distributed notaries.
* Written as a platform for distributed apps called CorDapps.
* Written in [Kotlin](https://kotlinlang.org), targeting the JVM.
Pull requests are appreciated. You can chat to the team on our forums and on our Slack.
It runs on the JVM and is mostly written in Kotlin.
Read our full and planned feature list [here](https://docs.corda.net/inthebox.html).
## Useful links
* [Getting started](https://docs.corda.net/getting-set-up.html)
* [Writing a CorDapp](https://docs.corda.net/creating-a-cordapp.html)
* [Project website](https://corda.net)
* [Documentation](https://docs.corda.net)
## Development State
Corda is currently in early development and is not yet ready for production. Breaking
changes will happen on minor versions until 1.0. Experimentation with Corda is recommended.
Pull requests, experiments, and contributions are encouraged and welcomed.
## Background
The project is supported by R3, a financial industry consortium, which is why it
contains some code for financial use cases and why the documentation focuses on finance. The goal is to use it
to construct a global ledger, thus simplifying finance and reducing the overheads of banking. But it is run as
a typical open source project and the basic technology of a peer to peer decentralised database may be useful
for many different projects. We'd love to hear about any interesting experiments you do with it!
to construct a global ledger, simplifying finance and reducing the overheads of banking. But it is run as
an open source project and the basic technology of a peer to peer decentralised database may be useful
for many different projects.
# Useful links
## Contributing
* [Getting started](https://docs.corda.net/getting-set-up.html)
* [Project website](https://corda.net)
* [Documentation](https://docs.corda.net)
Please read [here](./CONTRIBUTING.md).
## License
[Apache 2.0](./LICENSE.md)