summaryrefslogtreecommitdiffstats
path: root/repo_url/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'repo_url/README.md')
-rw-r--r--repo_url/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/repo_url/README.md b/repo_url/README.md
new file mode 100644
index 0000000..9cb0811
--- /dev/null
+++ b/repo_url/README.md
@@ -0,0 +1,6 @@
+# Understanding URLs to git repositories
+
+This is a helper library to parse git URLs, with some special knowledge of GitHub and GitLab URLs (more URLs schemes welcome).
+
+It's needed, because Cargo allows aribitrary URLs in the metadata, and people put all kinds of stuff in there. crates.rs needs to have canonical Git URLs and be able to query GitHub API about them.
+