diff --git a/README.md b/README.md index d10edee..5601c80 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,8 @@ My coding style is somewhat unique, but ultimately geared towards maximal readability. Along with extensive documentation in the code, I use type annotations and code comments indicating input/outputs shapes. (x,y,z) just indicate that any value is accepted at runtime. + +WARNING: Code is almost correct, but I still have to throw in a few details +to make it easy to access as an external library, as well as test. You can feel +free to use whatever is available right now, but I'll likely have the kinks ironed +out by Monday evening.