Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nathan-fiscaletti committed Feb 15, 2023
1 parent 744ba1b commit b91a2b3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@

Coattail is a secure [peer-to-peer](https://en.wikipedia.org/wiki/Peer-to-peer) remote execution and data publication service. It's intention is to provide a generic publication mechanism in which subscribers can utilize the publication data in anyway they see fit.

> This project is still in it's infancy and should not be used in any production environments or for any application that handles sensitive data.
![Preview](./docs/images/preview.gif)

# Features

|Feature|Documentation|
|---|---|
|Peer-to-peer architecture providing a decentralized base for communication.|[Architecture](./docs/architecture.md)|
|Peer-to-peer architecture providing a decentralized base for communication.|[Architecture](#)|
|Easy to use data manipulation, publication and subscription.|[Subscriptions](./docs/subscription.md)|
|Subscription based publication mechanism.|[Actions & Receivers](#managing-actions--receivers)|
|Support for secure signature based packet source verification.|[Authentication](#authentication)|
|Modern command line interface for managing instances.|[CLI Usage](./docs/cli.md)|
|Secure permission driven remote execution on peered instances.|[Tokens](#authentication)|
|Modern command line interface for managing instances.|[CLI Usage](#)|
|Secure permission driven remote execution on peered instances.|[Remote Execution](#)|
|Support for TLS providing a secure tunnel with end-to-end encryption for data transport.|[TLS](#configuring-tls-for-your-coattail-service)|

# Index
Expand Down Expand Up @@ -278,6 +280,8 @@ $ coattail action list --receivers

# Authentication

Coattail has a robust authentication protocol built in with features such as signature based packet source verification. Below we will outline how to configure this authentication mechanism, as well as how to issue or revoke authentication tokens and validation tokens.

## Configuring Authentication

### Token Ownership
Expand Down

0 comments on commit b91a2b3

Please sign in to comment.