From 7c588be3ded6abf1ad1f0729379a6722dcdb5dc7 Mon Sep 17 00:00:00 2001
From: Felix Morger <Felixhultin@yahoo.se>
Date: Mon, 2 Dec 2024 11:05:07 +0100
Subject: [PATCH] Update README.md

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a6f54ce..f87fe84 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,15 @@
 # Introduction
 
-This is a toolkit for automatically creating a HuggingFace repository for a Språkbanken resource. 
+This is a toolkit for automatically creating a Hugging Face repository for a Språkbanken resource. 
 
 # Usage
 
-TBD
+sb2hf is a command-line tool which creates a Hugging Face repository from a Språkbanken resource url (found at https://spraakbanken.gu.se/resurser). For example, if an authenticated user of the ```sbx`` organization of the user runs this: 
+
+```
+python sb2hf.py https://spraakbanken.gu.se/resurser/forarbeten1734 --push-to-hub
+```
+
+This dataset with the same resource name will be automatically uploaded: https://huggingface.co/datasets/sbx/forarbeten1734.
+
+To use this outside the Språkbanken Text organization, simply specify your own organization or user under the ``--hf-namespace`` argument.