Code formatting and adding README.

bhagyas · Oct 21, 2018 · 381a9d5 · 381a9d5
1 parent 17c6a8a
commit 381a9d5
Show file tree

Hide file tree

Showing 2 changed files with 199 additions and 167 deletions.
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,32 @@
+= Alfresco CLI -  Command line interface for Alfresco
+
+[abstract]
+Interact with the Alfresco repository with an interactive command line.
+
+== Target Audience
+- Alfresco Developers and Architects
+
+== Installation
+- Clone the repository
+- Install using `npm install -g && npm link`
+
+== Usage
+- Call `alfresco-cli` from your terminal.
+
+=== Commands and Operations
+- Login
+- Logout
+- List files
+- List sites
+- Upload files
+- Download files [TBD]
+- View Metadata
+
+== License 
+MIT License
+
+== Author
+- Bhagya Nirmaan Silva (about.me/bhagyas)
+
+== Contributors
+None