From 9a6169dce3f119f424411b7dc92d9cea8724c490 Mon Sep 17 00:00:00 2001
From: Arkadiusz Janz <arkadiusz.janz@pwr.edu.pl>
Date: Fri, 22 May 2020 13:52:12 +0000
Subject: [PATCH] Update README.md

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b8a7293..6d8b46c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,49 @@
 # cclutils
 
 A convenient API based on Corpus2 library for reading, writing, and processing
-textual corpora represented as CCL (XML) documents.
\ No newline at end of file
+textual corpora represented as CCL (XML) documents.
+
+#### IO
+
+###### Read CCL file
+
+```python
+import cclutils
+
+filepath = './example.xml'
+document = cclutils.read(filepath)
+```
+
+###### Read CCL with relations (REL file):
+
+```python
+
+cclpath = './example.xml'
+relpath = './exampel.rel.xml'
+document = cclutils.read(cclpath, relpath)
+```
+
+###### Specify tagset
+
+```python
+document = cclutils.read(cclpath, relpath, 'nkjp')
+```
+
+###### Write CCL
+
+```python
+document = cclutils.read(filepath)
+...
+cclutils.write(document, './out.xml')
+```
+
+or with relations:
+
+```python
+cclutils.write(document, './out.xml', rel_path='./out.rel.xml')
+```
+
+specify the tagset:
+```python
+cclutils.write(document, './out.xml', rel_path='./out.rel.xml', tagset='spacy')
+```
\ No newline at end of file
-- 
GitLab