Skip to content

Commit

Permalink
See #15. Updated README to reflect better .jsbeautifyrc support.
Browse files Browse the repository at this point in the history
  • Loading branch information
Glavin001 committed Jun 13, 2014
1 parent 4fdab97 commit 4d48679
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,44 @@
# atom-beautify package
# [atom-beautify](https://github.com/donaldpipowitch/atom-beautify)

[Beautify](https://github.com/einars/js-beautify) HTML, CSS and Javascript in Atom.
[Beautify](https://github.com/einars/js-beautify) HTML, CSS and JavaScript in Atom.

*Attention*: A different package with a similar name exist. Maybe you want to visit this one: [Beautifier](https://atom.io/packages/atom-beautifier).

## Usage

Open the Command Palette, and type `Beautify`. This will beautify JS, HTML or CSS files. (XML is supported as an experimental feature.) It will only beautify selected text, if a selection is found - if not, the whole file will be beautified.
Open the [Command Palette](https://github.com/atom/command-palette), and type `Beautify`.
This will beautify JS, HTML or CSS files.
XML is supported as an experimental feature.

It will only beautify selected text, if a selection is found - if not, the whole file will be beautified.

### Shortcut

You can also type `ctrl-alt-b` as a shortcut or click `Packages > Beautify` in the menu.

### Package Options

You can also choose to beautify on every file save.

You can change the current config by either using `.jsbeautifyrc` for all files or a non-standard variante with settings for every file type. You can see examples of both way inside [`examples/`](https://github.com/donaldpipowitch/atom-beautify/examples)

## Configuration

Edit your `.jsbeautifyrc` file in any of the following locations:

- Same directory as current file
- Project root
`atom-beautify` will recursively look up from the current file's directory to find `.jsbeautifyrc`.
- Your User's Home directory

You can see examples of both way inside [`examples/`](https://github.com/donaldpipowitch/atom-beautify/tree/master/examples)

## Contributing

[See all contributors on GitHub](https://github.com/donaldpipowitch/atom-beautify/graphs/contributors).

Please update the [CHANGELOG.md](https://github.com/donaldpipowitch/atom-beautify/blob/master/CHANGELOG.md)
file and submit a [Pull Request on GitHub](https://help.github.com/articles/using-pull-requests).

## License

MIT © [Donald Pipowitch](https://github.com/donaldpipowitch)
[MIT](https://github.com/donaldpipowitch/atom-beautify/blob/master/LICENSE.md) © [Donald Pipowitch](https://github.com/donaldpipowitch)

0 comments on commit 4d48679

Please sign in to comment.