Browse Source

Add license and update README

Konstantinos Lypitkas 5 years ago
parent
commit
2f96c1f878
2 changed files with 42 additions and 6 deletions
  1. 24 0
      LICENSE
  2. 18 6
      README.md

+ 24 - 0
LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org>

+ 18 - 6
README.md

@@ -8,26 +8,38 @@ FS Go is a tiny CLI tool in order to spawn a local file server.
 
 
 ### BUILD
 ### BUILD
 
 
+In order to build the executable run the following command:
+
 ```
 ```
-go build
+$ go build
 ```
 ```
 
 
 ### START THE SERVER
 ### START THE SERVER
 
 
+Starting the server is easy:
+
 ```
 ```
-./fs-go -port 8080 -dir .
+$ ./fs-go -port 8080 -dir .
 ```
 ```
 
 
-### GLOBAL INSTALLATION
+Only two parameters are needed:
+
+- **dir**: The directory that will be served. (**default**: `.`)
+- **port**: The port that the server will listen to. (**default**: `8080`)
+
+### INSTALL GLOBALLY
+
+If you only want to use this CLI tool as a binary then you can do that
+easily:
 
 
 ```
 ```
-go install
+$ go install
 ```
 ```
 
 
 Now you can use:
 Now you can use:
 
 
 ```
 ```
-fs-go
+$ fs-go
 ```
 ```
 
 
-in order to start a new instance.
+From anywhere in your system.