Skip to content

Commit 5d54e3e

Browse files
authored
Update README.md
1 parent 1e14314 commit 5d54e3e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In this setup, the Plugin handles all user authentication, with the Server havin
1414

1515
## Sequence Diagram
1616

17-
> Created with https://sequencediagram.org ([_source_](./sequence-diagram.txt))
17+
> Created with https://sequencediagram.org ([_source_](https://github.com/ohsu-comp-bio/funnel/blob/feature/plugins/plugins/sequence-diagram.txt))
1818
1919
![proposed-auth-design](./sequence-diagram.png)
2020

@@ -25,7 +25,7 @@ In this setup, the Plugin handles all user authentication, with the Server havin
2525
```console
2626
git clone https://github.com/ohsu-comp-bio/funnel-plugins
2727

28-
cd funnle-plugins
28+
cd funnel-plugins
2929

3030
make
3131
Building ./server...OK
@@ -51,7 +51,7 @@ In another terminal, send the request using of the examples below —
5151
<details>
5252
<summary>Example Users ⚙️</summary>
5353

54-
All ["Authorized" users](https://en.wikipedia.org/wiki/Structure_and_Interpretation_of_Computer_Programs#Characters) may be found in the "User Database" — [`example-users.csv`](./authorizer/example-users.csv):
54+
All ["Authorized" users](https://en.wikipedia.org/wiki/Structure_and_Interpretation_of_Computer_Programs#Characters) may be found in the "User Database" — [`example-users.csv`](https://github.com/ohsu-comp-bio/funnel/blob/feature/plugins/plugins/example-users.csv):
5555
> - Alyssa P. Hacker, a Lisp hacker
5656
> - Ben Bitdiddle
5757
> - Cy D. Fect, a "reformed C programmer"
@@ -65,7 +65,7 @@ Here the use of a simple text file to contain users is to show how a plugin can
6565

6666
### Example: Authorized User
6767

68-
Here we send a request to authenticate a user named 'Alyssa P. Hacker' who is an `Authorized` user (i.e. found in the "User Database" — [`example-users.csv`](./authorizer/example-users.csv)):
68+
Here we send a request to authenticate a user named 'Alyssa P. Hacker' who is an `Authorized` user (i.e. found in the "User Database" — [`example-users.csv`](example-users.csv)):
6969

7070
```console
7171
curl --header "Authorization: Bearer Alyssa P. Hacker" \
@@ -89,9 +89,11 @@ Error: User Foo not found ❌
8989

9090
# Next Steps 🚧
9191

92-
- [x] Add sequence diagram of Server/Plugin interactions
92+
- [ ] Add Server integration
93+
- [ ] Add updated sequence diagram of Server/Plugin interactions
9394
- [ ] Add steps/docs for writing additional custom plugins to integrate with Funnel...
9495
- [ ] Add real world use case example/docs
96+
- [ ] Add expected use cases, examples, and docs
9597

9698
# Additional Resources 📚
9799

0 commit comments

Comments
 (0)