From 78d0eef8b335bee7ba73706265c02ada55e9797c Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 31 Jan 2024 18:11:21 -0800 Subject: [PATCH] Added contributing section --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index deed356..1bc809b 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ try { } ``` -``` +```console Status Code: 400 Error: Sorry, the URL you entered is on our internal blacklist. It may have been used abusively in the past, or it may link to another URL redirection service. ``` @@ -139,3 +139,22 @@ Additionally, link can be shortened using [v.gd](https://v.gd/) by setting the ` ```kotlin Isgd.shorten("https://www.example.com/", isVgd = true) // returns https://v.gd/2z2ncj ``` + +## Contributing + +If you want to contribute to this project, all you have to do is clone the GitHub +repository: + +```console +git clone git@github.com:ethauvin/isgd-shorten.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd isgd-shorten +./bld compile +``` + +The project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all +the dependencies were downloaded and peruse the code.