Skip to content

Commit d97497c

Browse files
committed
Added CONTRIBUTING.md and made README.md more explicit
1 parent 30f605d commit d97497c

2 files changed

Lines changed: 48 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
Thanks for your interest in TokenGate.
4+
5+
---
6+
7+
This project is currently shared primarily as a proof of concept.
8+
Feel free to clone, fork, and experiment with the code.
9+
10+
If you'd like to contribute:
11+
12+
- Open an issues when problems arise
13+
- Keep contributions focused and small
14+
- Prefer clarity over cleverness
15+
- Preserve research tone of the project
16+
17+
Bug reports, doc clarifications, system modifications, all contributions are welcome.

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
Welcome to the TokenGate repository.
44

5+
---
6+
7+
### What it is:
8+
9+
A small experimental system for routing decorated synchronous functions
10+
through a token-managed concurrency model. It is intended to operate as
11+
its own concurrency workflow rather than alongside normal threading patterns.
12+
13+
### What it is not:
14+
15+
It is not presented as production code.
16+
17+
### Overview:
18+
519
TokenGate is an exploration of token-managed concurrency: a
620
concept for coordinating async orchestration with thread-backed
721
work in a structured way.
@@ -14,9 +28,8 @@ If you'd like the fuller overview, please start here:
1428

1529
- [Proof of Concept](./proof-of-concept.md)
1630

17-
You can also browse the code, run the demos, and see what the idea
18-
is aiming toward. If anything here is useful, interesting, or sparks
19-
an idea, that already makes this project worthwhile.
31+
If anything here is useful, interesting, or sparks an
32+
idea, that already makes this project worthwhile.
2033

2134
---
2235

@@ -71,4 +84,18 @@ def main():
7184

7285
if __name__ == "__main__":
7386
main()
74-
```
87+
```
88+
89+
---
90+
91+
## Project status
92+
93+
TokenGate is an active proof of concept.
94+
95+
Current focus:
96+
- Refine the core concurrency model
97+
- Improve system operability and confirm WebSocket behavior
98+
- Test the decorator/coordinator workflow
99+
- Gather feedback on API clarity and usability
100+
101+
This is a base architecture, not a finished product.

0 commit comments

Comments
 (0)