diff --git a/README.md b/README.md index d0c8441..b594c59 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,4 @@ regular videos. ## TODO: -- [ ] Make Documentation -- [ ] Build tooling according to said docs -- [ ] Use it myself -- [ ] ??? -- [ ] Profit? +- [ ] Get the thing working diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md new file mode 100644 index 0000000..4c682f6 --- /dev/null +++ b/docs/QUICKSTART.md @@ -0,0 +1,33 @@ +# Documentation + +Guide to reading commands + +``` +ytpm subcommand (optional) +``` + +## Initializing a Project + +To initialize a project, use the `init` subcommand. `init` will create a new directory unless specified. + +```sh +ytpm init (/path/to/directory/) +``` + +## Adding Sources + +To add a source, use the `add` subcommand. + +``` +ytpm add (subfolder) +``` + +Sources will be downloaded using `yt-dlp`, and will be placed in `sources/` + +## Downloading Sources + +To download sorces from an existing `ytpm` project, use the `sync` subcommand + +``` +ytpm sync +```