Skip to content

Commit 9904245

Browse files
committed
Update Ocha with True examples
1 parent d72d9da commit 9904245

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,31 @@
22
<img width="400" src="https://raw.githubusercontent.com/gakimball/ocha/master/assets/logo.png" alt="Ocha">
33
</h1>
44

5-
A BDD-style assertion library for Sass. Eventually it will maybe work with [True](https://github.com/oddbird/true).
5+
A BDD-style assertion library for Sass that works with the [True](https://github.com/oddbird/true) test runner.
66

77
## Installation
88

9-
It's not on npm yet!
9+
Install Ocha through npm or Bower.
10+
11+
```bash
12+
npm install ocha
13+
bower install ocha
14+
```
1015

1116
## Usage
1217

1318
Use the `expect()` mixin to write an assertion. Pass a value to check, and then a series of language functions. Most assertions also require a final value to compare with.
1419

1520
```scss
21+
@import 'true';
1622
@import 'ocha';
1723

18-
$value: 5
19-
@require expect($value to equal 5);
24+
@include test-module('Test Module') {
25+
@include test('Test') {
26+
$value: 5
27+
@require expect($value to equal 5);
28+
}
29+
}
2030
```
2131

2232
## API

0 commit comments

Comments
 (0)