aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index e25b35b..2aa4618 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
# helper-scripts
+These are some helpful [cross platform scripts](https://docs.vlang.io/other-v-features.html#cross-platform-shell-scripts-in-v) written with [v](https://vlang.io/).
+
+## How to use
+
+1. Install vlang as per [documentation](https://docs.vlang.io/installing-v-from-source.html) and [symlink](https://docs.vlang.io/hello-world.html) it.
+2. Clone this repo.
+3. Execute the scripts. \ No newline at end of file