Skip to content

Commit

Permalink
Cleaned up the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonNguyen committed Mar 23, 2012
1 parent 6d0bc04 commit 9732cec
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
44 changes: 44 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# FreshBooks API Library
Get up and running with the FreshBooks API instantly with this Google Chrome Extension!

## Installation

$ npm install express

or to access the `express(1)` executable install globally:

$ npm install -g express

## Quick Start

You can install the compiled app in Google Chrome by downloading the .crx file in the download section:
github.com/antonnguyen/downloads

Installing from source

Open up Google Chrome
Inside the preferences, go to the "Extensions" tab
Enable Developer mode by checking it off
Click on "Load unpacked extension"
Select the FreshBooks API Library folder

Install dependencies:

$ npm install -d

Start the server:

$ node app.js

## Features

* XML highlighting for easy reading
* Auto-XML generation as you type
* Connect with an authorization token or through oauth
* Authorization credentials saved with html5 local storage
* PDF compiler for invoice.getPDF and estimate.getPDF calls
* Image viewer for receipt.get calls
* Vim-style (h, j, k, l) keybindings for easy selection of resources and methods
* Auto-send your requests by hitting 'Enter'
* Curl requests generated for each call for use in terminal
3 changes: 2 additions & 1 deletion README → TODO
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Interact with the FreshBooks API within your browser!
1) Massive refactoring
2) Unsigned oauth requests (no consumer secret)
3) Oauth validation before sending request
4) Add autoupdating (possible via github.com download section?)
4) Add autoupdating (possible via github.com download section?)
5) Project_manager_id too long

0 comments on commit 9732cec

Please sign in to comment.