From 4192c2cd2e9daeb7018663996db53aa3ccb06e31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Offray=20Vladimir=20Luna=20C=C3=A1rdenas?= Date: Tue, 27 Jul 2021 19:10:00 -0500 Subject: [PATCH] Updates install instructions and usage example. --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 744e9cb..f42f011 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ ExoRepo provides syntactic sugar for Pharo's Iceberg to support repositories beyond GitLab, GitHub and Bitbucket. -To install this from Gitea, run from a playground: +## Installation + +### from Gitea + +Run from a playground: ```smalltalk location := FileLocator localDirectory / 'iceberg' / 'Offray' / 'ExoRepo'. @@ -17,4 +21,25 @@ To install this from Gitea, run from a playground: repository: 'gitlocal://', location fullName; baseline: 'ExoRepo'; load -``` \ No newline at end of file +``` + +### from GitHub + +Run from a playground: + +```smalltalk +Metacello new + repository: 'github://offray/ExoRepo/'; + baseline: 'ExoRepo'; + load. + ``` + + ## Usage + + To install the repository run: + + ```smalltalk + ExoRepo new + repository: 'https://code.tupale.co/Offray/TiddlyWikiPharo'; + load. + ``` \ No newline at end of file