Skip to content

Commit 469d901

Browse files
committed
update
1 parent 3194082 commit 469d901

File tree

3 files changed

+48
-34
lines changed

3 files changed

+48
-34
lines changed

LICENSE

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright © 2018 Zeb Zhao
5+
6+
Permission is hereby granted, free of charge, to any person
7+
obtaining a copy of this software and associated documentation
8+
files (the “Software”), to deal in the Software without
9+
restriction, including without limitation the rights to use,
10+
copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the
12+
Software is furnished to do so, subject to the following
13+
conditions:
14+
15+
The above copyright notice and this permission notice shall be
16+
included in all copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25+
OTHER DEALINGS IN THE SOFTWARE.

README.md

+14-28
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# indent.js
1+
# indent.js - pure code indentation for jsx, tsx, ts, js, html, css, less, scss
22

33
[![Build Status](https://travis-ci.org/zebzhao/indent.js.svg?branch=master)](https://travis-ci.org/zebzhao/indent.js)
44

5-
Fast minimalistic pure indentation of JavaScript, CSS, and HTML.
5+
Fast minimalistic pure code indentation. Indents JavaScript, Typescript, TSX, JSX, CSS, and HTML. Does not do any beautifying of your code, leave it as it is, only correctly indents it following some basic rules.
66

77
[Online indent.js demo](https://zebzhao.github.io/indent.js/)
88

@@ -13,12 +13,13 @@ You have following options to get indent.js:
1313
1. Install with [bower](http://bower.io): ```bower install indent.js```
1414
2. Install with [npm](https://www.npmjs.com): ```npm install indent.js```
1515

16-
### Download
16+
## Download
1717

18-
* [Minified (~4 kB)](https://raw.githubusercontent.com/zebzhao/indent.js/master/lib/indent.js)
19-
* [Not minified (~11 kB)](https://raw.githubusercontent.com/zebzhao/indent.js/master/lib/indent.js)
18+
* [Minified (~5 kB) no gzip](https://raw.githubusercontent.com/zebzhao/indent.js/master/lib/indent.js)
19+
* [Not minified (~11 kB) no gzip](https://raw.githubusercontent.com/zebzhao/indent.js/master/lib/indent.js)
2020

21-
Usage
21+
22+
## Usage
2223
---
2324

2425
### Browser Global
@@ -42,35 +43,20 @@ var indented = indent.indentJS(code, ' ');
4243
console.log(indented);
4344
```
4445

45-
---
46-
47-
This project is great for code editors and file watchers. I'd love to hear about how your projects use indent.js.
48-
49-
##Projects with indent.js:
46+
*If you like this project please leave a star. Your support is greatly appreciated.*
5047

51-
1. [JsWriter - Web-base JavaScript IDE](https://jswriter.com/)
48+
## Projects with indent.js:
5249

53-
Developers
54-
---
50+
1. [Spck.io - An offline web editor that keeps your data private](https://spck.io/)
5551

56-
ISupport for other languages would be nice, and greatly welcomed!
57-
Unfortunately, I do not know these languages well enough to construct rules for them.
5852

59-
###Languages still not supported:
53+
## Languages still not supported:
6054

61-
1. TypeScript
62-
2. CoffeeScript
63-
3. Pug
64-
4. Less/Sass
55+
1. CoffeeScript
56+
2. Pug
6557

66-
###Getting the project
58+
## Getting the project
6759

6860
1. Run `npm install` to install dependencies
6961
2. Run `npm test` to run tests in `tests` folder
7062
3. Run `npm run build` to build the project
71-
72-
## Contributing
73-
74-
This project follows the [GitFlow branching model](http://nvie.com/posts/a-successful-git-branching-model). The ```master``` branch always reflects a production-ready state while the latest development is taking place in the ```develop``` branch.
75-
76-
Each time you want to work on a fix or a new feature, create a new branch based on the ```develop``` branch: ```git checkout -b BRANCH_NAME develop```. Only pull requests to the ```develop``` branch will be merged.

package.json

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "indent.js",
3-
"version": "0.1.3",
3+
"version": "0.3.0",
44
"description": "Fast minimalistic pure indentation of JavaScript, CSS, and HTML.",
55
"main": "lib/indent.js",
66
"directories": {
@@ -31,12 +31,15 @@
3131
"url": "https://github.com/zebzhao/indent.js.git"
3232
},
3333
"keywords": [
34+
"beautifier",
3435
"indent",
35-
"indent.js",
36-
"indenter",
37-
"indentjs",
38-
"indentcss",
39-
"indenthtml"
36+
"jsx",
37+
"tsx",
38+
"typescript",
39+
"harmony",
40+
"pure",
41+
"unopinionated",
42+
"indentation"
4043
],
4144
"author": "Zeb Zhao",
4245
"license": "MIT",

0 commit comments

Comments
 (0)