aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmilien Devos <contact@emiliendevos.be>2020-05-22 22:27:45 +0200
committerEmilien Devos <contact@emiliendevos.be>2020-05-22 22:27:45 +0200
commit9207a6fe580c900ee302a2e1f0425f760f7d53ba (patch)
tree6239b06a9ed590a068b1603a8d633fa69a02df9c
parentf6d2eb6a698a13c6bc2a800793c3331a52a5e47a (diff)
add readme
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7432021
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# How to launch
+1. Install NodeJS
+2. `npm install`
+3. `npm start`
+
+# How to use
+Send your request to the server with the port 3000 and add your URL to the "url" query string like this:
+`http://localhost:3000/?url=https://example.org` \ No newline at end of file