From 6ff794534560ef67824327b74569ff99fd9481cb Mon Sep 17 00:00:00 2001 From: Cosmin Stroe Date: Sun, 21 Apr 2024 15:27:16 -0500 Subject: [PATCH] Add use cases to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 432fca8..3c639a7 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,13 @@ An API for reading, editing, and writing SVN dump files. +## What does this do? + +You can use this library to **modify the history of existing Subversion repositories**. Some use cases are: +* removing large binary files from the Subversion revision history +* adding a revision `0` so that you can upgrade old repositories to work with a newer version of Subversion tools +* convert the Subversion repositories to other version control systems, like git (no support for this out-of-the-box, but you can process all the Subversion history and execute corresponding `git` commands) + ## Background SVN dump files are created via the `svnadmin dump` or `svnrdump dump` commands, and contain all the