Skip to content

Commit f1b15e3

Browse files
authored
Merge pull request #1965 from adumesny/master
moved API doc to be more predominant
2 parents 2f3b74f + b1a0929 commit f1b15e3

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# gridstack.js
22

33
[![NPM version](https://img.shields.io/npm/v/gridstack.svg)](https://www.npmjs.com/package/gridstack)
4-
[![Dependency Status](https://david-dm.org/gridstack/gridstack.js.svg)](https://david-dm.org/gridstack/gridstack.js)
5-
[![devDependency Status](https://david-dm.org/gridstack/gridstack.js/dev-status.svg)](https://david-dm.org/gridstack/gridstack.js#info=devDependencies)
64
[![Coverage Status](https://coveralls.io/repos/github/gridstack/gridstack.js/badge.svg?branch=develop)](https://coveralls.io/github/gridstack/gridstack.js?branch=develop)
75
[![downloads](https://img.shields.io/npm/dm/gridstack.svg)](https://www.npmjs.com/package/gridstack)
86

@@ -20,18 +18,16 @@ If you find this lib useful, please donate [PayPal](https://www.paypal.me/alaind
2018
Join us on Slack: https://gridstackjs.troolee.com
2119

2220
[![Slack Status](https://gridstackjs.troolee.com/badge.svg)](https://gridstackjs.troolee.com)
23-
2421
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2522
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2623
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*
2724

28-
- [Demo and examples](#demo-and-examples)
25+
- [Demo and API Documentation](#demo-and-api-documentation)
2926
- [Usage](#usage)
3027
- [Install](#install)
3128
- [Include](#include)
3229
- [Basic usage](#basic-usage)
3330
- [Requirements](#requirements)
34-
- [API Documentation](#api-documentation)
3531
- [Extend Library](#extend-library)
3632
- [Extend Engine](#extend-engine)
3733
- [Change grid columns](#change-grid-columns)
@@ -53,10 +49,9 @@ Join us on Slack: https://gridstackjs.troolee.com
5349
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
5450

5551

56-
# Demo and examples
57-
58-
Please visit http://gridstackjs.com and [these demos](http://gridstackjs.com/demo/)
52+
# Demo and API Documentation
5953

54+
Please visit http://gridstackjs.com and [these demos](http://gridstackjs.com/demo/), and complete [API documentation](https://github.com/gridstack/gridstack.js/tree/master/doc)
6055

6156
# Usage
6257

@@ -160,17 +155,14 @@ grid.load(serializedData);
160155
GridStack.init();
161156
```
162157

158+
...or see list of all [API and options](https://github.com/gridstack/gridstack.js/tree/master/doc) available.
159+
163160
see [jsfiddle sample](https://jsfiddle.net/adumesny/jqhkry7g) as running example too.
164161

165162
## Requirements
166163

167164
GridStack no longer requires external dependencies as of v1.0.0 (lodash was removed in v0.5.0 and jquery API in v1.0.0). v3.0.0 is a complete HTML5 re-write which removes all jquery dependency (still available for legacy apps). All you need to include now is `gridstack-h5.js` and `gridstack.min.css` (layouts are done using CSS column based %).
168165

169-
## API Documentation
170-
171-
Documentation can be found [here](https://github.com/gridstack/gridstack.js/tree/master/doc).
172-
173-
174166
## Extend Library
175167

176168
You can easily extend or patch gridstack with code like this:

0 commit comments

Comments
 (0)