From fa1c2fa538e3b3a4ad9c025f6d09299a2dd6ff15 Mon Sep 17 00:00:00 2001 From: Jack Hodgkinson <30505104+jhodgdev@users.noreply.github.com> Date: Wed, 26 Jan 2022 15:17:45 +0000 Subject: [PATCH] minor tweaks to README.md --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 38eab4b..70dde1c 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,43 @@ # Agora -Agora is a set of Plutus scripts that compose together to form a Governance system. +Agora is a set of Plutus scripts that compose together to form a governance system. ### What is Agora Goals: -- Agora aims to reduce duplication in Liqwid and LiqwidX and to serve as a one-size-fits-all governance library for projects on the Cardano Network. -- Agora aims to be modular and allow customizing specific needs, but presents an opinionated architecture. + +- Agora aims to reduce duplication in Liqwid and LiqwidX and to serve as a one-size-fits-all governance library for projects on the Cardano blockchain. +- Agora aims to be modular and flexible for specific needs but presents an opinionated architecture. Non-goals: -- Agora is not a DAO. It doesn't have tokenomics or even a token. It is simply a library for governance. -- Agora doesn't aim to provide any primitive tools for plutus that are not governance-specific. For this, see [plutus-extra](https://github.com/Liqwid-Labs/plutus-extra/). + +- Agora is not a DAO. It doesn't have tokenomics or even a token. It is simply a library for governance. +- Agora doesn't aim to provide any primitive tools for Plutus that are not governance-specific. For this, see [plutus-extra](https://github.com/Liqwid-Labs/plutus-extra/). ## Project setup -An up to date `nix` (>=2.3) is required to build this project. For information on how to install, see the [nixos website](https://nixos.org/download.html). Important: See also [this section](https://github.com/input-output-hk/plutus#nix-advice) on binary caches. +An up to date version of the [`nix` package manager](nixos.org) (>=2.3) is required to build this project. For information on how to install, see the [nixos website](https://nixos.org/download.html). Important: See also [this section](https://github.com/input-output-hk/plutus#nix-advice) on binary caches. -Open a dev-shell with `nix develop`, and build with `cabal build`. +Open a dev-shell with `nix develop` and build with `cabal build`. ## Documentation -See documentation of the Agora architecture in [docs](./docs). +Documentation for Agora may be found in [docs](./docs). ## Road-map ### v1 -- [ ] Governor -- [ ] Treasury -- [ ] Staking pool -- [ ] Proposals -- [ ] Effects + +- [ ] Governor +- [ ] Treasury +- [ ] Staking pool +- [ ] Proposals +- [ ] Effects ### v2 -- [ ] Rewards distribution + +- [ ] Rewards distribution ### Beyond - - +- [ ] ...