Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoshiaki Kawazu committed Feb 27, 2017
1 parent 07e70dc commit 37fd954
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 22 deletions.
50 changes: 29 additions & 21 deletions README.md
@@ -1,19 +1,18 @@
# unbreaker

[![NPM](https://nodei.co/npm/unbreaker.png)](https://nodei.co/npm/unbreaker/)
[![Build Status](https://travis-ci.org/kawaz/unbreaker.svg?branch=master)](https://travis-ci.org/kawaz/unbreaker)
[![Coverage Status](https://coveralls.io/repos/github/kawaz/unbreaker/badge.svg?branch=master)](https://coveralls.io/github/kawaz/unbreaker?branch=master)

Convert line breakable string to non-breakable character sequence.

![](demo.gif)
Create line unbreakable character sequence from breakable strings.

# Features

- [x] Convert breakable character sequence to unbreakable
- [x] Don't join explicit newline
- [x] Don't destroy combining character sequence like `xx`
- [x] Don't destroy combining character sequence like this "ఠ్ఠ"
- [x] Don't destroy emoji character
- [ ] Support CLI
- [x] Support CLI
- [ ] Support reverting to breakable from unbreakable

# Install
Expand All @@ -22,28 +21,37 @@ Convert line breakable string to non-breakable character sequence.
npm install unbreaker
```

# Usage

## CLI
# Example

```
$ npm install -g unbreaker
$ unbreaker '(*´ω`*)' 'This is unbreakable.'
(*´ω`*)
This is unbreakable.
```javascript
var unbreaker = require('unbreaker');
[
'This is not breakable.',
'ヽ(=´▽`=)ノ',
'•̀.̫•́✨'
].forEach(function(breakable) {
console.log( unbreaker(breakable) )
});
```

You can copy and paste the output to Notes or HTML, etc...
You can copy and paste the output to TextEdit or html, etc...

## Code
# CLI

```javascript
var unbreaker = require('unbreaker');
var kaomoji = '(*´ω`*)';
console.log(unbreaker(kaomoji));
You can use cli.

```console
$ unbreaker '(*´ω`*)' あいうえお
(*⁠´ω⁠`⁠*)
あ⁠い⁠う⁠え⁠お
```

# Thanks
[]()
# Screenshot

![unbreaker-demo](https://cloud.githubusercontent.com/assets/156236/23367668/7050a68c-fd4e-11e6-9b7a-21567e335b1f.gif)

# Related

- [Dango - Unbreakable Kaomoji](http://getdango.com/unbreakable-kaomoji/)


2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -4,7 +4,7 @@
"type": "git",
"url": "git+ssh://git@github.com/kawaz/unbreaker.git"
},
"version": "1.0.6",
"version": "1.0.8",
"author": "Yoshiaki Kawazu <kawazzz@gmail.com> (https://twitter.com/kawaz)",
"homepage": "https://github.com/kawaz/unbreaker",
"license": "MIT",
Expand Down

0 comments on commit 37fd954

Please sign in to comment.