Skip to content

Commit

Permalink
readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus authored Jun 25, 2016
1 parent b472cdb commit 28806f2
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

> Sublime plugin to prefix your CSS or SCSS
You shouldn't have to care about vendor prefixes. Now you don't have too.
You shouldn't have to care about vendor prefixes. Now you don't have to!

![](screenshot.gif)

Adding prefixes manually is a chore. It's also hard to keep track of where and which prefixes are needed. This plugin uses the [Autoprefixer](https://github.com/ai/autoprefixer) library to prefix properties and values according to the [Can I Use](http://caniuse.com/) database. Which means it will only add the necessary prefixes and not bloat your stylesheet. It even lets you specify what browsers you want to target. In addition it will remove existing prefixes which are no longer needed.
Adding prefixes manually is a chore. It's also hard to keep track of where and which prefixes are needed. This plugin uses the [Autoprefixer](https://github.com/postcss/autoprefixer) module to prefix properties and values according to the [Can I Use](http://caniuse.com) database. Which means it will only add the necessary prefixes and not bloat your stylesheet. It even lets you specify what browsers you want to target. In addition it will remove existing prefixes which are no longer needed.

Works with CSS and SCSS, but not other preprocessors.

Expand All @@ -16,23 +16,23 @@ Works with CSS and SCSS, but not other preprocessors.
Install `Autoprefixer` with [Package Control](https://packagecontrol.io) and restart Sublime.

**You need to have [Node.js](http://nodejs.org) >=0.12.0 installed.**<br>
Make sure it's in your $PATH by running `node -v` in your command-line.<br>
Make sure it's in your $PATH by running `node --version` in your command-line.<br>
On macOS you need to make sure it's in `/usr/local/bin` or symlink it there.

See the Autoprefixer version in use [here](https://github.com/sindresorhus/sublime-autoprefixer/blob/master/node_modules/autoprefixer/package.json#L3).
See the Autoprefixer version in use [here](https://github.com/sindresorhus/sublime-autoprefixer/blob/master/node_modules/autoprefixer/package.json#L120).


## Getting started

In a CSS file, open the Command Palette *(Cmd+Shift+P)* and choose `Autoprefix CSS`. You can alternatively create one or more selections before running the command to only prefix those parts.
In a CSS file, open the Command Palette *(<kbd>Cmd</kbd> <kbd>Shift</kbd> <kbd>P</kbd>)* and choose `Autoprefix CSS`. You can alternatively create one or more selections before running the command to only prefix those parts.

### Options

*(Preferences > Package Settings > Autoprefixer > Settings - User)*
*(Preferences Package Settings Autoprefixer Settings - User)*

You can specify which browsers you need to support using an array of rules.

See the [supported browser names](https://github.com/ai/autoprefixer#browsers).
See the [supported browser names](https://github.com/postcss/autoprefixer#browsers).

#### Default

Expand All @@ -55,13 +55,16 @@ This will add the needed prefixes for the last version of each browser, all brow

### Keyboard shortcut

You can also set up a keyboard shortcut to run the command by opening up "Preferences > Key Bindings - User" and adding your shortcut with the `autoprefixer` command.
You can also set up a keyboard shortcut to run the command by opening up "Preferences Key Bindings - User" and adding your shortcut with the `autoprefixer` command.

Example:

```json
[
{ "keys": ["alt+super+p"], "command": "autoprefixer" }
{
"keys": ["alt+super+p"],
"command": "autoprefixer"
}
]
```

Expand Down

0 comments on commit 28806f2

Please sign in to comment.