-
Notifications
You must be signed in to change notification settings - Fork 884
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,19 @@ | ||
|
|
||
|  | ||
|
|
||
| **Sheetsee.js** is a client-side library for connecting Google Spreadsheets to a website and visualizing the information in tables, maps and charts. | ||
| ### Sheetsee.js is a client-side library for connecting Google Spreadsheets to a website and visualizing the information in tables, maps and charts. | ||
|
|
||
| ## Modules | ||
| --- | ||
|
|
||
| Each of **sheetsee.js**'s features are divided into modules. Use just the parts you need; see docs on [building](./docs/building.md). If you don't want to build your own, you can just use the full library which includes all modules, it's [here on GitHub](http://www.github.com/jlord/sheetsee.js). | ||
| **This repository is for the [project website](http://jlord.github.io/sheetsee.js) and provides a [compiled version sheetsee.js](./js/sheetsee.js).** Use the compiled version if you want _all_ of what is available in Sheetsee. If you want just the parts that you're going to use in your project and nothing more, you can [build a custom version](./docs/building.md). | ||
|
|
||
| **Each part of Sheetsee has its own repository and issues should be opened there.** General issues/pull requests for the site are OK here. | ||
|
|
||
| | Module | Contains | Docs | | ||
| | ------------------- | --------------------------------------------------------------------------------------------------- | ---------------------------- | | ||
| | **sheetsee-core** | **Included in any build**. Gets you started and has the working-with-your-data functions. | [Doc](./docs/sheetsee-core.md) | | ||
| | **sheetsee-tables** | Contains everything you'll need to create a table including sortable columns, pagination and search.| [Doc](./docs/sheetsee-tables.md) | | ||
| | **sheetsee-maps** | For making maps with your point, line or polygon spreadsheet data. Built on Mapbox.js. | [Doc](./docs/sheetsee-maps.md) | | ||
| | **sheetsee-charts** | Includes 3 basic d3 charts: bar, line and pie. You can also [use your own](docs/custom-charts.md). | [Doc](./docs/sheetsee-charts.md) | | ||
|
|
||
| ## Spreadsheets!? | ||
|
|
||
| Google Spreadsheets can be used as simple and collaborative databases, they make getting a data driven site going much easier than traditional databases. Read more about using spreadsheets for databases [here](./docs/basics.md). | ||
|
|
||
| ## In the Wild | ||
|
|
||
| What can you make with **Sheetsee.js**? Lots of things, here are some examples: | ||
|
|
||
| - [Hack-Spots](http://jlord.github.io/hack-spots) | ||
| - [Combine with IFTTT](http://jlord.us/blog/your-own-instagram.html) | ||
| - [Real Python Support Desk](http://www.realpython.com/support) | ||
|
|
||
| **List your sheetsee project here: file an [issue or pull request](http://www.github.com/jlord/sheetsee.js).** | ||
|
|
||
| # Resources & Documentation | ||
|
|
||
| More resources on using Sheetsee.js: | ||
|
|
||
| | Getting Started | Ideas | Use | Demos | | ||
| | --- | --- | --- | --- | | ||
| | [About Sheetsee.js](./docs/about.md) | [Fork-n-Go](./docs/fork-n-go.md) | [Sheetsee-core](./docs/sheetsee-core.md) | [Table Demo](./demos/demo-table.html) | | ||
| | [Building Sheetsee](./docs/building.md) | [Tips!](./docs/tips.md) | [Sheetsee-tables](./docs/sheetsee-tables.md) | [Table Demo](./demos/demo-table.html) | | ||
| | [Basics](./docs/basics.md) | [Custom charts](./docs/custom-charts.md) | [Sheetsee-maps](./docs/sheetsee-maps.md) | [Map Demo](./demos/demo-map.html) | | ||
| | | | [Sheetsee-charts](./docs/sheetsee-charts.md) | [Chart Demo](./demos/demo-chart.html) | | ||
|
|
||
| ## Note on New Google Spreadsheets | ||
|
|
||
| Google recently updated their Google Spreadsheets and the API. For a bit this was breaking things using the old API, including Tabletop. This has been fixed and the latest version of tabletop.js works on both old and new spreadsheets. **Be sure to include at least version 1.3.4 in your project.** | ||
| ## Repositories for Sheetsee Components | ||
|
|
||
| | Component | Description | Repo | | ||
| | ------------------- | --------------------------------------------------------------------------------------------------- | ---------------------------- | | ||
| | `sheetsee-core` | **Included in every build**. Gets you started and has the working-with-your-data functions. | [jlord/sheetsee-core](https://github.com/jlord/sheetsee-core) | | ||
| | `sheetsee-tables` | Contains everything you'll need to create a table including sortable columns, pagination and search.| [jlord/sheetsee-tables](https://github.com/jlord/sheetsee-tables) | | ||
| | `sheetsee-maps` | For making maps with your point, line or polygon spreadsheet data. Built on Mapbox.js. | [jlord/sheetsee-maps](https://github.com/jlord/sheetsee-maps) | | ||
| | `sheetsee-charts` | Includes 3 basic d3 charts: bar, line and pie. You can also [use your own](docs/custom-charts.md). | [jlord/sheetsee-charts](https://github.com/jlord/sheetsee-charts) | |