added documents

Author: mammad2c

README.md

@@ -1 +1,47 @@
 # mmd-gitlab-backuper
+
+A command line package to backup your repositories in your local from Gitlab. Because of U.S Sanctions there is high risk without any backup.
+
+### Requirements:
+
+- node js v10 above
+
+### How to work:
+
+- grab a Personal Access Token from your gitlab account.
+
+Login on your gitlab account and click on your avatar on top right. Click on `Settings` and from the left sidebar click on `Access Tokens`:
+
+Full url for gitlab.com: [https://gitlab.com/profile/personal_access_tokens](https://gitlab.com/profile/personal_access_tokens)
+
+Please tik the fields like in the picture
+
+Also provide a name for this token. something like `backup-token`.
+
+![doc1](images/doc1.jpg)
+
+Click on `Create personal access token` and after that grab your token:
+
+![doc2](images/doc2.jpg)
+
+- now run command below in witch directory you want to do backup:
+  `npx mmd-gitlab-backuper -t 'YOUR-ACCESS-TOKEN'`
+
+wooow!! that's all. Now your repos will be available in `./repos` directory.
+
+### Options:
+
+See options by `npx mmd-gitlab-backuper --help`:
+
+```
+Options:
+      --version  Show version number                                   [boolean]
+  -t, --token    your Gitlab Personal Access Token                      [string]
+  -o, --output   Backup to output directory, defaults to ./repos        [string]
+  -u, --url      Specify Gitlab URL, defaults to https://gitlab.com     [string]
+      --help     Show help                                             [boolean]
+```
+
+for example you can change default backup directory like this:
+
+`npx mmd-gitlab-backuper -t 'YOUR-ACCESS-TOKEN' -o './gitlab-repo'`

images/doc1.jpg

@@ -9,7 +9,7 @@ const cliProgress = require("cli-progress");
 const argv = require("yargs");
 
 argv
-  .usage("Save your repo in gitlab")
+  .usage("Backup gitlab repo in local machine")
   .option("token", {
     alias: "t",
     type: "string",

images/doc2.jpg

@@ -1,7 +1,7 @@
 {
   "name": "mmd-gitlab-backuper",
   "description": "a package to backup from all projects that you have on gitlab",
-  "version": "0.8.5",
+  "version": "1.0.0",
   "main": "index.js",
   "license": "MIT",
   "author": {