Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lbeckman314 authored Dec 25, 2024
1 parent 402ae8c commit 9c57aa7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ This repo contains Funnel Plugin development using the [`go-plugin`](https://git

In this setup, the Plugin handles all user authentication, with the Server having no "knowledge" or record of user credentials/tokens (e.g. [`example-users.csv`](./authorizer/example-users.csv)).

TODO:
- Add steps/docs for writing additional custom plugins to integrate with Funnel...
- Add sequence diagram of Server/Plugin interactions

# Quick Start ⚡

## 1. Start the Server
Expand Down Expand Up @@ -71,6 +67,11 @@ All ["Authorized" users](https://en.wikipedia.org/wiki/Structure_and_Interpretat
Here the use of a simple text file to contain users is to show how a plugin can be written and integrated into Funnel — real world use cases might involve more complex mechanisms for tracking users (e.g OAuth)...

# Next Steps 🚧
[] Add steps/docs for writing additional custom plugins to integrate with Funnel...
[] Add sequence diagram of Server/Plugin interactions
[] Add real world use case example/docs

# Additional Resources 📚

- https://github.com/hashicorp/go-plugin
Expand Down

0 comments on commit 9c57aa7

Please sign in to comment.