Merge pull request #1 from gevorg95/master

Mirroring now supported, xml -> udl, update readme

Author: gevorg95

GitHub/API.cls.xml

@@ -1,9 +1,9 @@
 # GitHubAPI
-Github API for InterSystems Caché
+Github API for InterSystems Data Platforms
 
 ## Installation
 
-Import xmls into any namespace and compile.
+Import into any namespace and compile.
 
 ## Usage
 
@@ -19,5 +19,34 @@ All availible API calls are listed in class documentation of `GitHub.API` class.
 
 Some workflows to automate work with GitHub are availible in `GitHub.Workflows` class.
 
+### Mirroring
+
+1. Create repos.json file: 
+
+```
+{
+    "from": "intersystems-ru",        // owners: user or organization
+    "to": "intersystems-community",
+    "org": 1,                         // 1: if you want to mirror in organization owner. 0: if user owner 
+    "repos": [                        // just repos name f.e. 'GitHubAPI'
+        "repo1",  
+        "repo2",
+        "..."
+    ]
+}
+```
+
+2. Set repos.json location in param name, class `GitHub.API`. `Parameter Directory = "C:/temp/mirror/"`
+3. `Set api = ##class(GitHub.API).%New("user","pass")`
+4. `Do api.Mirror()`
+
+#### Task
+
+Create task:
+- Task Type = `RunLegacyTask`
+- ExecuteCode = `Do ##class(GitHub.API).UpdateMirrors()`
+- Choose the right time to start the task
+
+
 ## Some API method I want is not availible. What do I do?
 Everyone is welcome to add methods or wokflows via pull requests.