diff --git a/README.md b/README.md
index e69de29..cc54d61 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,8 @@
+# ytid
+simple Go package to extract a Youtube ID from a passed URL
+
+## methods
+GetID(url string) string
+
+GETIDWithError(url string) (string, error)
+