Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Commit 356e396

Browse files
committed
update readme to inform about v1.0
1 parent e1a765f commit 356e396

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ More are coming soon...
1616
[![Build Status](https://travis-ci.org/orthes/medium-editor-insert-plugin.png?branch=master)](https://travis-ci.org/orthes/medium-editor-insert-plugin)
1717
[![Bower version](https://badge.fury.io/bo/medium-editor-insert-plugin.svg)](http://badge.fury.io/bo/medium-editor-insert-plugin)
1818

19+
---
20+
21+
This is a branch for a current working 0.* version. If you want to see, test or contribute to an upcoming **version 1.0**, go to [1.0 branch](https://github.com/orthes/medium-editor-insert-plugin/tree/1.0).
22+
23+
---
1924

2025
## Table of Contents
2126

@@ -24,8 +29,7 @@ More are coming soon...
2429
- [Usage](#usage)
2530
- [Options](#options)
2631
- [Methods](#methods)
27-
- [Development](#development)
28-
- [Contributing](#contributing)
32+
- [Development & Contributing](#development)
2933
- [Author](#author)
3034

3135

@@ -138,7 +142,12 @@ Use example:
138142
$('.editable').mediumInsert('disable');
139143
```
140144

141-
## <a name="development"></a>Development
145+
## <a name="development"></a>Development & Contributing
146+
147+
[![Stories in Ready](https://badge.waffle.io/orthes/medium-editor-insert-plugin.svg?label=ready&title=Ready)](http://waffle.io/orthes/medium-editor-insert-plugin)
148+
149+
I'm happy when you not only use the plugin, but contribute your improvements, too. First of all, go to [waffle.io](http://waffle.io/orthes/medium-editor-insert-plugin) (that's the blue icon above),
150+
where you'll find list of all work, that need to be done. Feel free to grab one issue, assign it to yourself and start working.
142151

143152
The plugin uses [Grunt](http://gruntjs.com/) for automating development tasks and [Bower](http://bower.io/) for package management. To install all the necessities for development run these commands:
144153

@@ -154,13 +163,7 @@ These are available Grunt tasks:
154163
- **test**: runs jshint and qunit
155164
- **watch**: watches for modifications on script/scss files and runs js/css task
156165

157-
158-
## <a name="contributing"></a>Contributing
159-
160-
I'm happy when you not only use the plugin, but contribute your improvements, too. To do that, you need to meet only two requirements:
161-
162-
1. Use the same coding style as the plugin
163-
2. Write QUnit tests (if you're adding a new funcionality) and test your changes with **grunt test**
166+
Please, test you're code to your best knowledge, especially if you're adding new features.
164167

165168

166169
## <a name="author"></a>Author

0 commit comments

Comments
 (0)