Skip to content

Commit

Permalink
adding basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tehbilly committed Apr 3, 2014
1 parent f2bde06 commit 389e63c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
`servethis` is a simple cross-platform file serving utility written in [go](http://golang.org/). It provides a quick and easy way to share any files on your filesystem via http.

## Installation
Assuming you have go [installed](http://golang.org/doc/install/) you can simply run `go get github.com/tehbilly/servethis`.

## Usage
Run `servethis -h` to see the plethora of options available to you!.

Without arguments `servethis` will serve the contents of the current working directory on port 8000. To change either the `path` that's served or the `port` that data is served on use the flags with the same names. For example: `servethis -path c:/share/stuff -port 9191`.

0 comments on commit 389e63c

Please sign in to comment.