diff --git a/README.md b/README.md index 15840de33..fe7dbaae9 100644 --- a/README.md +++ b/README.md @@ -2,37 +2,32 @@ # Proxeus Core ---------------- -Main repository of the Proxeus core platform. -Proxeus combines a powerful document automation tool with the wide-ranging -blockchain functionalities, enabling users to digitize and monetize their IP. -You can access the source code of this application and various extensions -on [GitHub](https://github.com/ProxeusApp). +Proxeus combines a powerful automation tool with a form builder, document generator and blockchain connection - enabling you to digitize, secure, and tap into the value of data flows. Access the full source code of available modules and extensions [@ProxeusApp](https://github.com/ProxeusApp). -## User guides +![Screenshot of Proxeus workflow from the handbook](https://github.com/ProxeusApp/community/raw/master/handbook/Proxeus%20-%20The%20Complete%20Handbook_html_10299e76126cc024.png) -Get help to make the most of the platform in the **[User Handbook](https://github.com/ProxeusApp/community/blob/master/handbook/handbook.md)**. - -For detailed information about payment setup, check the [XES-Payment Readme](docs/xes-payment.md). +## User Guides -To learn more about Smart Contracts, see the documentation in the [Solidity Readme](https://github.com/ProxeusApp/proxeus-contract). +Get help to make the most of the platform in the **[User Handbook](https://github.com/ProxeusApp/community/blob/master/handbook/handbook.md)**. -### Quickstart +To learn more about Smart Contracts using Solidity, see the documentation in the [proxeus-contract](https://github.com/ProxeusApp/proxeus-contract). -You can get all the information to run Proxeus here. In addition to the Docker installation documented below, we are making facilitated "one-click" automated build configurations available for select cloud platforms. +For detailed information about payment setup (currently unsupported), check the [XES-Payment](docs/xes-payment.md) project. -- [Linode StackScript](deploy/linode/README.md) +## Installation -Please [contact us](https://github.com/ProxeusApp/community/discussions/3) if you are interested in additional providers on this list. +Proxeus is primarily a Web application, intended for access with a web browser. The [Proxeus Association](https://proxeus.org) maintains a demo instances you can use to test the product, and can recommend a service provider to help you or your business get set up. There is also a prototype [desktop application](https://github.com/ProxeusApp/storage-app/blob/master/docs/overview.md). -### Contributing +In addition to the developer guidelines below, several "one-click" deployment configurations are available for select cloud platforms: -As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or -engaging in insightful discussions. Especially, we are looking forward to receiving contributions for external workflow nodes. +- [Docker Compose](docker-compose.yml) +- [Linode StackScript](deploy/linode/README.md) +- [DigitalOcean Droplet](deploy/digitalocean/README.md) -See the **[Contributing Guide](docs/contributing.md)** for further directions. +Please [contact us](https://github.com/ProxeusApp/community/discussions/3) if you are interested in seeing additional providers on this list. -## Development guide +## Development Please read the [Developer Manual](https://doc.proxeus.com) to learn more about the Proxeus platform. @@ -58,6 +53,13 @@ Please note that the domain you set up on SparkPost MUST match the **reply-to** If all goes well, Proxeus should be available at http://localhost:1323. The next step will be to [configure](docs/configure.md) your instance for the first time. +## Contributing + +As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or +engaging in insightful discussions. Especially, we are looking forward to receiving contributions for external workflow nodes. + +See the **[Contributing Guide](docs/contributing.md)** for further directions. + ### Security Issues If you find a vulnerability that may affect live or testnet deployments please DO NOT file a public issue - send your report privately to info@proxeus.org diff --git a/go.mod b/go.mod index 1b71b389f..88cf90984 100644 --- a/go.mod +++ b/go.mod @@ -79,4 +79,4 @@ replace ( github.com/labstack/echo-contrib => github.com/labstack/echo-contrib v0.0.0-20180222075343-7d9d9632a4aa // fix https://github.com/ProxeusApp/proxeus-core/issues/216 gopkg.in/gavv/httpexpect.v2 => github.com/gavv/httpexpect/v2 v2.2.0 // fix https://github.com/gavv/httpexpect/issues/60 gopkg.in/urfave/cli.v1 => github.com/urfave/cli v1.22.5 // fix https://github.com/ProxeusApp/proxeus-core/issues/213 -) +) \ No newline at end of file diff --git a/go.sum b/go.sum index 99228e506..bcaac0232 100644 --- a/go.sum +++ b/go.sum @@ -886,4 +886,4 @@ honnef.co/go/tools v0.1.3/go.mod h1:NgwopIslSNH47DimFoV78dnkksY2EFtX0ajyb3K/las= moul.io/http2curl v1.0.1-0.20190925090545-5cd742060b0e h1:C7q+e9M5nggAvWfVg9Nl66kebKeuJlP3FD58V4RR5wo= moul.io/http2curl v1.0.1-0.20190925090545-5cd742060b0e/go.mod h1:nejbQVfXh96n9dSF6cH3Jsk/QI1Z2oEL7sSI2ifXFNA= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= -rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= \ No newline at end of file