diff --git a/README.md b/README.md index b67aecd..90e9bae 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # GitHubUpdater -Sync GitHub repositories into InterSystems Cache +Sync GitHub repositories into InterSystems Cache. + +Installation +----------- + +1. Download Task.cls.xml and import it into Caché (any namespace, further referred to as {Namespace}). + +Usage +----------- + +To create task for syncing GitHub repository → Cache instance do the following: + +1. Go to SMP → System Operation → Task Manager → New Task +2. Set Name as desired +3. Set Namespace to run task in to {Namespace} +4. Set Task type to GitHub Update +5. Set GitHubURL to a valid GitHub repository, eg: https://github.com/intersystems-ru/Cache-MDX2JSON +7. Set Namespace to a Namespace you want to download GitHub repository to +8. Optionally provide Username, Password (for private repos or very frequent updates). +9. Set up the Branch you need. Possible values are - commit/branch/tag +8. Set other parameters as desired and finish creation of the task + +After task runs at least once you will get GitHubURL repository contents in Namespace + +Continuous Integration +----------- + +If you want more functionality check out [CacheGitHubCI](https://github.com/intersystems-ru/CacheGitHubCI) project.