ryanackley avatar ryanackley committed 0a015b3

updated the README file.

Comments (0)

Files changed (1)

-tincr
-=====
+Tincr
+=====
+This is the source code for the [Tincr Chrome Extension](http://tin.cr). The docs are hosted [here](http://tin.cr/docs.html).
+
+Building
+======
+Tincr is a chrome extension. You can simply checkout the source code and load it as an unpacked extension in Chrome. This will 
+require that Chrome is in Developer Mode (go to chrome://extensions and tick the box). Alternatively, you can pack the extension yourself using Chrome. 
+
+## NPAPI Chrome File API
+Tincr relies on an NPAPI plugin (NPAPI Chrome File API) for all of it's native file support. For example, reading and writing local files from a chrome extension and watching local directories for changes. The source code for this is [here](https://bitbucket.org/ryanackley/npapi-chrome-file-api/src).
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.