Skip to content

Commit

Permalink
docs: update branding, add security policy
Browse files Browse the repository at this point in the history
  • Loading branch information
sohkai committed Jul 18, 2020
1 parent 841915f commit 9f39ad0
Show file tree
Hide file tree
Showing 3 changed files with 136 additions and 22 deletions.
74 changes: 74 additions & 0 deletions .github/assets/aragonos.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security

For more information about Aragon-related security and contact information, please visit our [security policy page](https://wiki.aragon.org/association/security/).

## Status

aragonOS has passed a number of [independent professional security audits and rolling reviews](https://wiki.aragon.org/association/security/).

There is an ongoing [bug bounty program](https://wiki.aragon.org/dev/bug_bounty/) with a bounty pool of $250,000 USD for rewarding hackers who find new security vulnerabilities. [More information](https://wiki.aragon.org/dev/bug_bounty/).
75 changes: 53 additions & 22 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,63 @@
# aragonOS <img align="right" src="https://raw.githubusercontent.com/aragon/design/master/readme-logo.png" height="80px" /> [![Travis branch](https://img.shields.io/travis/aragon/aragonOS/master.svg?style=for-the-badge)](https://travis-ci.org/aragon/aragonOS) [![Coveralls branch](https://img.shields.io/coveralls/aragon/aragonOS/master.svg?style=for-the-badge)](https://coveralls.io/github/aragon/aragonOS?branch=master) [![npm](https://img.shields.io/npm/v/@aragon/os.svg?style=for-the-badge)](https://www.npmjs.com/package/@aragon/os)

This repo contains Aragon's reference implementation of [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html).
<p align="center"><img width="50%" src=".github/assets/aragonos.svg"></p>

<div align="center">
<!-- NPM -->
<a href="https://npmjs.org/package/@aragon/os">
<img src="https://img.shields.io/npm/v/@aragon/os.svg?style=flat-square" alt="Version" />
</a>
<!-- Security -->
<a href="SECURITY.md">
<img src="https://img.shields.io/badge/security-audited-green?style=flat-square" alt="Security" />
</a>
<!-- Coverage -->
<a href="https://coveralls.io/github/aragon/aragonOS?branch=master">
<img src="https://img.shields.io/coveralls/aragon/aragonOS/master.svg?style=flat-square" alt="Coverage" />
</a>
</div>

<div align="center">
<h4>
<a href="https://aragon.org">
Website
</a>
<span> | </span>
<a href="https://hack.aragon.org/docs/aragonos-intro.html">
Documentation
</a>
<span> | </span>
<a href="https://github.com/aragon/aragonOS/releases">
Releases
</a>
<span> | </span>
<a href="CONTRIBUTING.md">
Contributing
</a>
<span> | </span>
<a href="https://spectrum.chat/aragon/aragonos">
Support &amp; Chat
</a>
</h4>
</div>

# aragonOS

Reference implementation of [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html), a smart contract framework for building decentralized organizations.

#### 🚨 Security review status: bug bounty
aragonOS 4 has undergone two independent professional security reviews, and the issues raised have been resolved. However there is a [bug bounty program](https://wiki.aragon.org/dev/bug_bounty/) for rewarding hackers who find security vulnerabilities. There is a bounty pool of $250,000 USD, you can find more information [here](https://wiki.aragon.org/dev/bug_bounty/).

#### 👋 Get started contributing with a [good first issue](https://github.com/aragon/aragonOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
aragonOS has passed a number of [independent professional security audits and rolling reviews](https://wiki.aragon.org/association/security/) and has an ongoing $250,000 USD bug bounty program.

See [SECURITY.md](SECURITY.md) for more security-related information.

#### 👋 Get started contributing with a [good first issue](https://github.com/aragon/aragonOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

Don't be shy to contribute even the smallest tweak. Everyone will be especially nice and helpful to beginners to help you get started!

## Documentation

Visit the [Aragon Developer Portal](https://hack.aragon.org/docs/aragonos-intro.html) for in-depth documentation on the [architecture](https://hack.aragon.org/docs/aragonos-ref.html) and different parts of the system.
Visit the [Aragon Developer Portal](https://hack.aragon.org/docs/aragonos-intro.html) for in-depth documentation.

The [reference documentation](https://hack.aragon.org/docs/aragonos-ref.html) explains the various smart contract components and how to use them.

## Developing aragonOS locally

Expand All @@ -31,19 +78,3 @@ OWNER=[APM owner address] ENS=[ENS registry address] npx truffle exec --network

- `ENS`: If no ENS registry address is provided, it will deploy a dummy ENS instance to the network. If the ENS registry is provided, the name `aragonpm.eth` must be owned by the deployer account.
- `OWNER`: The account that will be the initial owner of the APM registry

## Adding aragonOS as a dependency to your Aragon app

```
npm i --save-dev @aragon/os
```

Check the [Aragon Developer Portal](https://hack.aragon.org) for detailed documentation and tutorials on how to use aragonOS to build an Aragon app.

## Contributing

For more details about contributing to aragonOS, please check the [contributing guide](./CONTRIBUTING.md).

## Help

For help and support, feel free to contact us at any time on the [aragonOS Spectrum channel](https://spectrum.chat/aragon/aragonos).

0 comments on commit 9f39ad0

Please sign in to comment.