[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/rubocop 1372ee3 60/64: Tweak some wording
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/rubocop 1372ee3 60/64: Tweak some wording |
Date: |
Wed, 11 Aug 2021 10:08:05 -0400 (EDT) |
branch: elpa/rubocop
commit 1372ee3fc1daf7dc8d96741b03e4aff5f7ae3906
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Tweak some wording
---
README.md | 23 ++++++++++++++++-------
1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 447eec2..2eaf0d9 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,25 @@
A simple Emacs interface for [RuboCop](https://github.com/rubocop-hq/rubocop).
+It doesn't aim to compete with general-purpose packages providing lint
integration, but rather to provide the simplest way to leverage the essential
RuboCop functionality like:
+
+* checking code style
+* auto-formatting code
+* auto-correcting code
+
+Most of the package's commands are meant to be used on demand (when needed),
but
+you can also enable automatic code correction on save.
+
## Installation
Please, note that the current version of `RuboCop.el` requires `RuboCop` 0.9.0
or later.
+### MELPA
+
+If you're an `package.el` user,
+you can install rubocop.el from the [MELPA](http://melpa.org/) and
+[MELPA Stable](http://stable.melpa.org/) repositories.
+
### Manual
Just drop `rubocop.el` somewhere in your `load-path`. I
@@ -18,12 +33,6 @@ favour the folder `~/.emacs.d/vendor`:
(require 'rubocop)
```
-### MELPA
-
-If you're an Emacs 24 user or you have a recent version of package.el
-you can install rubocop.el from the [MELPA](http://melpa.org/) and
-[MELPA Stable](http://stable.melpa.org/) repositories.
-
## Usage
Command | Description
| RuboCop mode binding
@@ -80,7 +89,7 @@ You can change the shell command used by `rubocop-format-*`
commands via `ruboco
## Alternatives
-Flycheck and Flymake provide more sophisticated integration with various lint
tools, including RuboCop.
+[Flycheck](https://www.flycheck.org) and Flymake (Emacs built-in) provide more
sophisticated integration with various lint tools, including RuboCop.
There's also [rubocopfmt](https://github.com/jimeh/rubocopfmt.el), which
provides functionality similar to RuboCop.el, but is focused exclusively on the
auto-correction side of things.
- [nongnu] elpa/rubocop c0cb592 37/64: Kill the dash.el dependency, (continued)
- [nongnu] elpa/rubocop c0cb592 37/64: Kill the dash.el dependency, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 4fdf643 40/64: Add missing space, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 1285711 44/64: [Fix #22] Add a clean way to load RuboCop extensions, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop d4dad32 48/64: Add missing space, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 080454e 54/64: Add a note about rubocop-keymap-prefix, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 6c9c5a9 55/64: Add a bunch of commands for code formatting, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop f5fd18a 64/64: Add the ability to format on save, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop b0c5bc2 62/64: Tweak a heading, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 608a3c1 58/64: Release 0.6.0, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 0131536 39/64: Fix a docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 1372ee3 60/64: Tweak some wording,
ELPA Syncer <=
- [nongnu] elpa/rubocop 2c884cd 25/64: Merge pull request #15 from fap-/load_tramp_dependency, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop f947fb0 30/64: Fix byte-compile warning about unused variable, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 02ad056 35/64: [Fix #17] Consider rubocop installed if bundled, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 676cabe 36/64: Expand the project root path, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop a809fa7 42/64: [Fix #24] Always run RuboCop from the project's root when within a, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 03bf155 52/64: Run auto-correct automatically on save (#29), ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 38d982a 56/64: Add a note about alternative packages, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop d44737a 43/64: Fix a reference to RuboCop, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 980bedb 49/64: Release 0.5, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 8e9ec29 06/64: Update for RuboCop 0.9 (fixes #1), ELPA Syncer, 2021/08/11