Document the requirements

Signed-off-by: Ikey Doherty <ikey@solus-project.com>
getsolus · Dec 6, 2016 · 9328171 · 9328171
1 parent df79390
commit 9328171
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,17 @@ binman is a [Solus project](https://solus-project.com/).
 
 ![logo](https://build.solus-project.com/logo.png)
 
+Requirements
+------------
+
+`binman` should provide easy maintainence of `eopkg` repositories without the need for any host side tooling. It should provide git like syntax to enable creation, modification, and deletion of repositories.
+
+It should support the concept of a processing queue, where we wait for a full upload payload to become available, before then merging them into the repository database.
+
+To reduce the cost of indexing a repository (many thousands of packages) a simple database should be used to enable very quick dumping to the `eopkg-index.xml`.
+
+`binman` should also support the automatic creation of `.delta.eopkg` delta packages to reduce the cost of update for users. While the existing `binman.py` implementation can do all these things, it is very limited, inefficient, and often misses delta opportunities.
+
 License
 -------