Skip to content

Commit

Permalink
Add README documentation for pep8; limit lines to 80 chars
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb531 committed Feb 12, 2015
1 parent f2de344 commit b24f5d2
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
*Copyright 2015 Caleb Evans*
*Released under the MIT license*

YouVersion Suggest is an Alfred workflow which allows you to search the online [YouVersion](https://www.youversion.com/) bible quickly and conveniently.
YouVersion Suggest is an Alfred workflow which allows you to search the online
[YouVersion](https://www.youversion.com/) bible quickly and conveniently.

![YouVersion Suggest in action](screenshots/chapters.png)

## Usage

Type the `yv` keyword, along with a space and a phrase representing the bible reference you wish to find. The phrase can be partial book name, chapter, verse, or range of verses. You may also include an option version (translation) at the end of your query. As you type, YouVersion Suggest will display a list of suggestions matching your query.
Type the `yv` keyword, along with a space and a phrase representing the bible
reference you wish to find. The phrase can be partial book name, chapter, verse,
or range of verses. You may also include an option version (translation) at the
end of your query. As you type, YouVersion Suggest will display a list of
suggestions matching your query.

### Query Examples

Expand All @@ -21,18 +26,26 @@ Type the `yv` keyword, along with a space and a phrase representing the bible re

## Testing

If you are contributing to the project and would like to run the included unit tests, run the following command in the project directory:
If you are contributing to the project and would like to run the included unit
tests, run the following command in the project directory:

```
python -m unittest tests
```

Note that running these unit tests requires Python 2.7 or newer (Python 3 is not supported).

### Running an individual test case

If you wish to run a single test case, reference the module name like so:

```
python -m unittest tests.test_search_book
```

### Requirements for running tests

Note that running these unit tests requires Python 2.7. Running these tests also
requires the `pep8` module, which you can install using `pip`:

```
pip install pep8
```

0 comments on commit b24f5d2

Please sign in to comment.