From c2993aa3ba7f4b8a8b922dcee5ee1bcd246fc782 Mon Sep 17 00:00:00 2001 From: hemanth-hk Date: Sun, 5 Apr 2020 22:10:05 +0530 Subject: [PATCH] Added some sections --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12aaf5d..78b74e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -### Synix: A no flag nodeJS CLI \ No newline at end of file +## [Synix](https://synixjs.github.io/): A no-flag nodeJs CLI to make the use of command-line easy and uniform + +### Getting started +```bash + +# installation +$ npm i -g synix + +# initialisation +$ sx init code # for vscode + +# checking version +$ sx versiuon # or sx v + +``` +### Basic usage +```bash + +$ sx ls +# lists the folders and files in the cwd + +$ sx mkdir +# creates that folder in your cwd + +``` + +#### A complete guide of all the commands is written [here](https://synix-docs.netlify.com/ccc/commands.html) +--- + +> Star the repository if you like it, and I hope this speeds up your development + +### Contributors +If you want to contribute to this then create an issue and then we'll assign you. A more detailed way is present [here](https://synix-docs.netlify.com/ccc/contribute.html)