diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ba4d0a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# mf + +A serverless meme finder with full-text search (thanks to SQLite, but you have +to describe all the images yourself) + +``` +Usage: mf [-C=] create + or mf [-C=] list + or mf [-C=] search + or mf [-C=] prune + + or mf [-C=] {info|show} ... + or mf [-C=] delete ... + or mf [-C=] edit + or mf [-C=] get + or mf [-C=] set + +-C= changes the current working directory to before a +subcommand is executed. This causes the database to be looked up in +, all file paths are relative to and database creation +to be inside of + +create creates a database in the current directory (or ) + +prune removes all metadata entries that correspond to non-existent files, then +vaccums the database + +delete only deletes the metadata for the files specified, not the actual files +themselves + +get outputs the file's path, source, description, and miscellaneous information +delimited by a null-byte +```