Skip to content

Commit

Permalink
Added a quick getting started paragraph.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kelderic authored Jun 12, 2017
1 parent c3043a5 commit a2e1ba5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@ To allow for more quickly building out simple Google Maps JS API powered web pag
## Docs

Right now, all docs are inline. They are very thorough though, so you shouldn't have any trouble following along.

--------

## How To Use

In the source folder, there are two files. The first is the main script and the other is a stylesheet. If you download them and include them in your project, then call `new Mapstractor(args)`.

If you'd like minified versions, then close the repo, run `npm install`, and then run `grunt dist`, and a new `dist` folder will be created alongside the `src` folder, with minified versions of the files.

0 comments on commit a2e1ba5

Please sign in to comment.