Skip to content

Commit 98a1c25

Browse files
author
vitalets
committed
readme: improve structure and add bakers
1 parent 69221eb commit 98a1c25

File tree

1 file changed

+36
-22
lines changed

1 file changed

+36
-22
lines changed

README.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,27 @@
11
# X-editable
22
In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery.
33

4-
## Live Demo
5-
**http://vitalets.github.io/x-editable/demo.html**
6-
7-
## Pull Requests
8-
Please submit all Pull Requests to the `develop` branch: https://github.com/vitalets/x-editable/tree/develop
9-
More details are in [CONTRIBUTING.md](/CONTRIBUTING.md).
10-
11-
## Issue Tracker
12-
Please report all issues here: https://github.com/vitalets/x-editable/issues
13-
14-
## User Support
15-
Unfortunately, due to this project being supported by volunteers we cannot provide user support at this time. Please try a site like Stack Overflow: http://stackoverflow.com/questions/tagged/x-editable
4+
## Contents
5+
* [Live Demo](#live-demo)
6+
* [Installation](#installation)
7+
* [Manual download](#manual-download)
8+
* [Bower](#bower)
9+
* [CDN](#cdn)
10+
* [Getting Started](#getting-started)
11+
* [Documentation](#documentation)
12+
* [Issue Tracker](#issue-tracker)
13+
* [Project Status](#project-status)
14+
* [Contribution](#contribution)
15+
* [Bakers](#bakers)
16+
* [License](#license)
1617

17-
## Documentation
18-
**http://vitalets.github.io/x-editable**
19-
20-
## Project Status
21-
Actively Maintained
18+
## Live Demo
19+
Visit [X-editable demo](http://vitalets.github.io/x-editable/demo.html) to see all controls in action.
2220

23-
## How to get it
21+
## Installation
2422

2523
### Manual download
26-
Use **http://vitalets.github.io/x-editable** main page.
24+
Use links on [X-editable home page](http://vitalets.github.io/x-editable).
2725

2826
### Bower
2927
````
@@ -55,16 +53,32 @@ jQuery only build:
5553
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/jquery-editable/js/jquery-editable-poshytip.min.js"></script>
5654
````
5755

56+
## Getting Started
57+
How to start using X-editable is described on [X-editable website](http://vitalets.github.io/x-editable/docs.html).
5858

59-
## Reporting issues
60-
Please **provide jsFiddle** when creating issues!
61-
It's really saves much time. Use these as template:
59+
## Documentation
60+
Documentation on all available widgets and code samples can be found on [X-editable website](http://vitalets.github.io/x-editable/docs.html).
61+
62+
## Issue Tracker
63+
Feel free to open [issues](https://github.com/vitalets/x-editable/issues).
64+
Please include working code sample in issue body. To save the time use these jsFiddle templates:
6265
1. [jsFiddle Bootstrap 3](http://jsfiddle.net/xBB5x/15155/)
6366
2. [jsFiddle Bootstrap 2](http://jsfiddle.net/xBB5x/1817/)
6467
3. [jsFiddle jQuery-ui](http://jsfiddle.net/xBB5x/2511/)
6568
4. [jsFiddle jQuery](http://jsfiddle.net/xBB5x/197)
6669
Your feedback is very appreciated!
6770

71+
## Project Status
72+
Not actively maintained.
73+
74+
## Contribution
75+
Please submit all Pull Requests to the **develop** branch. More details are in [CONTRIBUTING.md](/CONTRIBUTING.md).
76+
77+
## Bakers
78+
[![Logo Flatlogic](https://user-images.githubusercontent.com/1473072/48839602-0edfda80-ed9d-11e8-9e2d-eb8d4828ddcb.png)](https://flatlogic.com/admin-dashboards)
79+
80+
Admin Dashboard Templates made with Vue, React and Angular by [Flatlogic](https://flatlogic.com/admin-dashboards).
81+
6882
## License
6983
Copyright (c) 2012 Vitaliy Potapov
7084
Licensed under the MIT license.

0 commit comments

Comments
 (0)