Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

README tweaks

  • Loading branch information...
commit 7bfe87106c8ffc4df19a227b86de09169c3fbd0a 1 parent 553608e
@dchelimsky dchelimsky authored
Showing with 11 additions and 10 deletions.
  1. +11 −10 README.md
View
21 README.md
@@ -1,21 +1,22 @@
# rspec-core [![Build Status](https://secure.travis-ci.org/rspec/rspec-core.png?branch=master)](http://travis-ci.org/rspec/rspec-core) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rspec/rspec-core)
-```
-gem install rspec # for rspec-core, rspec-expectations, rspec-mocks
-gem install rspec-core # for rspec-core only
-```
+rspec-core provides the structure for writing executable examples of how your
+code should behave, and an `rspec` command with tools to constrain which
+examples get run and taylor the output.
-# overview
+## install
-rspec-core provides the structure for writing executable examples of how
-your code should behave. It uses the words "describe" and "it" so we can
-express concepts like a conversation:
+ gem install rspec # for rspec-core, rspec-expectations, rspec-mocks
+ gem install rspec-core # for rspec-core only
+ rspec --help
+
+## basic structure
+
+RSpec uses the words "describe" and "it" so we can express concepts like a conversation:
"Describe an order."
"It sums the prices of its line items."
-## basic structure
-
```ruby
describe Order do
it "sums the prices of its line items" do
Please sign in to comment.
Something went wrong with that request. Please try again.