Commits

Miki Tebeka committed 6d65218

ignore and README

Comments (0)

Files changed (2)

+syntax: glob
+
+README.html
+nrsc
+`nrsc` - Resource Compiler for Go
+=================================
+`nrsc` compiles a directory of resource into a Go source file so you can still
+deploy a single executable as a web server with all the CSS, image files, JS ...
+included.
+
+Invocation
+==========
+::
+
+    nrsc path_to_resource_dir
+
+This will emit to standard output a Go source file code (in package `main`)
+
+API
+===
+The main object is `nrsc`, it has the following interface
+
+`nrsc.Handle(prefix string)`
+    This will register with the `net/http` module to handle all paths starting with prefix. 
+
+    When a request is handled, `prefix` is stripped and then a resource is
+    located and served.
+
+    Resource that are not found will cause an HTTP 404 response.
+    
+
+`nrsc.Get(path string) Resource`
+
+    Will return a resource interface (or `nil` if not found) (see resource interface below).
+    This allows you more control on how to serve.
+
+
+Resource Interface
+------------------
+
+`func Open() io.Reader`
+    Returns a reader to resource data
+
+`func Length() int`
+    Returns resource size (to be used with `Content-Length` HTTP header).
+
+`func Type() string`
+    Returns mime type (to be used with `Content-Type` HTTP header).
+
+`func Time() time.Time`
+    Returns modification time (to be used with `Last-Modified` HTTP header).
+    
+
+Status
+======
+Current status of the code is "playing". Nothing really written. There's an
+example implementation in the `resources` directory and a web server in `hw.go`.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.