Skip to content

Commit c8094c5

Browse files
authored
Improved headings
Improved the headings in the README. Changed all headings to the same syntax, fixed heading levels and changed to bold where headings were used for emphasis.
1 parent 49e8676 commit c8094c5

File tree

1 file changed

+17
-25
lines changed

1 file changed

+17
-25
lines changed

README.md

+17-25
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
## IMPORTANT: [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/) Please upgrade to Ruby >=2.3 or >=2.2.8 before installing Guard!
1+
# Guard
22

3-
### (To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version).
3+
**IMPORTANT: [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/) Please upgrade to Ruby >=2.3 or >=2.2.8 before installing Guard! To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version.**
44

55
:exclamation: Guard is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
66

7-
Guard
8-
=====
9-
107
[![Gem Version](https://img.shields.io/gem/v/guard.svg?style=flat)](https://rubygems.org/gems/guard) [![Build Status](https://travis-ci.org/guard/guard.svg?branch=master)](https://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.svg)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard/badges/gpa.svg)](https://codeclimate.com/github/guard/guard) [![Test Coverage](https://codeclimate.com/github/guard/guard/badges/coverage.svg)](https://codeclimate.com/github/guard/guard) [![Inline docs](http://inch-ci.org/github/guard/guard.svg)](http://inch-ci.org/github/guard/guard)
118

129
<img src="http://f.cl.ly/items/0A0M3W2x3I1P450z341U/guard-Icon.png" alt="Guard Icon" align="right" />
@@ -30,22 +27,21 @@ the following places:
3027

3128
Before you file an issue, make sure you have read the _[known issues](#issues)_ and _[file an issue](#file-an-issue)_ sections that contains some important information.
3229

33-
#### Features
30+
## Features
3431

3532
* File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.
3633
* Support for visual system notifications.
3734
* Huge eco-system with [more than 220](https://rubygems.org/search?query=guard-) Guard plugins.
3835
* Tested against Ruby 2.2.8, 2.3.5, 2.4.2, JRuby & Rubinius.
3936

40-
#### Screencast
37+
## Screencast
4138

4239
Two nice screencasts are available to help you get started:
4340

4441
* [Guard](http://railscasts.com/episodes/264-guard) on RailsCast.
4542
* [Guard is Your Best Friend](http://net.tutsplus.com/tutorials/tools-and-tips/guard-is-your-best-friend) on Net Tuts+.
4643

47-
Installation
48-
------------
44+
## Installation
4945

5046
The simplest way to install Guard is to use [Bundler](http://bundler.io).
5147

@@ -81,7 +77,7 @@ to Ruby on Mac OS
8177
X](https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X).
8278

8379

84-
#### Avoiding gem/dependency problems
80+
## Avoiding gem/dependency problems
8581

8682
**It's important that you always run Guard through Bundler to avoid errors.**
8783

@@ -105,7 +101,7 @@ If you're getting sick of typing `bundle exec` all the time, try one of the foll
105101

106102
* Or, for RubyGems < 2.2.0 check out the [Rubygems Bundler](https://github.com/rvm/rubygems-bundler).
107103

108-
#### Add Guard plugins
104+
## Add Guard plugins
109105

110106
Guard is now ready to use and you should add some Guard plugins for your specific use. Start exploring the many Guard
111107
plugins available by browsing the [Guard organization](https://github.com/guard) on GitHub or by searching for `guard-`
@@ -122,8 +118,7 @@ end
122118
See the init section of the Guard usage below to see how to install the supplied plugin template that you can install and
123119
to suit your needs.
124120

125-
Usage
126-
-----
121+
## Usage
127122

128123
Guard is run from the command line. Please open your terminal and go to your project work directory.
129124

@@ -142,35 +137,32 @@ directory for a `.Guardfile`.
142137

143138
Please look here to see all the [command line options for Guard](https://github.com/guard/guard/wiki/Command-line-options-for-Guard)
144139

145-
Interactions
146-
------------
140+
## Interactions
141+
147142
Please read how to [interact with Guard](https://github.com/guard/guard/wiki/Interacting-with-Guard) on the console and which [signals](https://github.com/guard/guard/wiki/Interacting-with-Guard#guard-signals) Guard accepts
148143

149144

150-
Guardfile DSL
151-
-------------
145+
## Guardfile DSL
146+
152147
For details on extending your `Guardfile` look at [Guardfile examples](https://github.com/guard/guard/wiki/Guardfile-examples) or look at a list of commands [Guardfile-DSL / Configuring-Guard](https://github.com/guard/guard/wiki/Guardfile-DSL---Configuring-Guard)
153148

154-
Issues
155-
------
149+
## Issues
156150

157151
Before reporting a problem, please read how to [File an issue](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#file-an-issue).
158152

159-
Development / Contributing
160-
--------------------------
153+
## Development / Contributing
161154

162155
See the [Contributing Guide](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#development).
163-
164-
#### Author
156+
### Author
165157

166158
[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
167159

168-
#### Core Team
160+
### Core Team
169161

170162
* R.I.P. :broken_heart: [Michael Kessler](https://github.com/netzpirat) ([flinkfinger.com](http://www.flinkfinger.com)).
171163
* [Rémy Coutable](https://github.com/rymai).
172164
* [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg), [thibaud.gg](http://thibaud.gg/)).
173165

174-
#### Contributors
166+
### Contributors
175167

176168
[https://github.com/guard/guard/graphs/contributors](https://github.com/guard/guard/graphs/contributors)

0 commit comments

Comments
 (0)