Describe API - first step

David-OConnor · Apr 18, 2022 · a7867be · a7867be
1 parent 4c6ec9b
commit a7867be
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -0,0 +1,19 @@
+# Pyflow commands API
+
+* [] `new` - Create a project folder with the basics file structure
+
+    Usage: 
+
+    ```
+    pyflow new <project_name>
+    ```
+
+
+    Arguments:
+
+    * [] `--src` - Creates `src` folder instead of `<project_name>` folder
+
+* [] `init` - Create a `pyproject.toml` from [] requirements.txt, [] pipfile, [] setup.py, etc. 
+    To be run inside project folder with these files.
+
+* [] `add` - the