Skip to content

Commit 6209f85

Browse files
committed
docs(README.md): add notice about maintainence status
1 parent 8c0f5c5 commit 6209f85

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,26 @@ A runtime type system for JavaScript with full [Flow](https://flowtype.org/) com
77

88
---
99

10+
## Maintenance Status
11+
12+
This project is not very well maintained anymore due to its complexity and maintainers' burnout with Flow in general.
13+
14+
### Statement from @jedwards1211
15+
16+
At the moment I need to keep this working in some production projects that use it for API input validation
17+
(using the `optInOnly` option instead of blanket runtime validation everywhere).
18+
19+
However, I would like to eventually migrate those projects to either:
20+
- a library where I declare validators that I can extract value types from. I created [`typescript-validators`](https://github.com/jcoreio/typescript-validators)
21+
for this purpose in TypeScript
22+
- a very pared-down version of `babel-plugin-flow-runtime` that generates validators where requested from Flow type annotations,
23+
but only supports certain types and doesn't automatically inject runtime validation everywhere.
24+
25+
If I had the time I would even migrate my production projects to TypeScript though, so I'm not sure I'll continue to use
26+
Flow and `flow-runtime` heavily in the long term.
27+
28+
## Contributing
29+
1030
This is a [lerna](https://github.com/lerna/lerna) powered mono-repo, composed of the following projects:
1131

1232
- [flow-runtime](./packages/flow-runtime): The core runtime type system.
@@ -16,7 +36,7 @@ This is a [lerna](https://github.com/lerna/lerna) powered mono-repo, composed of
1636
- [flow-runtime-mobx](./packages/flow-runtime-mobx): Adds mobx support to flow-runtime.
1737
- [flow-runtime-docs](./packages/flow-runtime-docs): React powered documentation site.
1838

19-
## Contributing
39+
### Getting started
2040

2141
First clone the repo:
2242

0 commit comments

Comments
 (0)