Skip to content

Commit 8dcd427

Browse files
authored
Revise README with updated features and usage
Updated features, active domain, planned work, and usage sections in README.
1 parent 0b23319 commit 8dcd427

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,36 @@ Random Code API is a centralized API that provides access to all the random serv
77

88
## Features
99
<!-- List key features of your API here -->
10-
- Feature 1:
11-
- Feature 2:
12-
- Feature 3:
10+
- Feature 1: Webhooks! i can push events to any webhook submitted and drop them when id like. its all stored on a sql lite db
11+
- Feature 2: calculator for job work time remaining
12+
- Feature 3: event log for stuff
13+
- feature 4: my first SQLite db!
1314
- ...
1415

1516
---
1617

1718
## Active Domain
1819
<!-- Include the link to the active domain or live API here -->
19-
[Your API Live Domain](#)
20+
(not live currently) [Your API Live Domain](#)
2021

2122
---
2223

2324
## Open / Planned Work
2425
<!-- Describe features or improvements you plan to implement -->
25-
- Planned Work 1:
26-
- Planned Work 2:
27-
- Planned Work 3:
26+
- Planned Work 1: discord notifs for events
27+
- Planned Work 2: internal event log and controller
28+
- Planned Work 3: server health monitor / status page stuff?
29+
- planned: rate limiting
30+
- planned: security + preventing sql injection
2831
- ...
2932

3033
---
3134

3235
## Usage
3336
<!-- Include instructions for how to use your API -->
34-
1. Endpoint 1:
35-
2. Endpoint 2:
36-
3. Endpoint 3:
37+
1. webhook endpoints wil lbe here
38+
2. math endpoints will be here
39+
3. health will be here
3740
- ...
3841

3942
---

0 commit comments

Comments
 (0)