Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #282

Merged
merged 1 commit into from
Dec 19, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,33 @@

# Proxeus Core
----------------
Main repository of the Proxeus core platform.
Main repository of the Proxeus 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 document automation tool with the wide-ranging blockchain functionalities, enabling users to digitize, secure, and extract value from their IP. You can access the source code of this application and various extensions on [GitHub](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, and is currently not intended for use on a desktop computer. 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.

### 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.

Expand All @@ -58,6 +54,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 [email protected]
Expand Down