iv-org-mirror/shard-spectator
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-spectator.git synced 2024-08-15 00:53:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add goal to README

Browse source
This commit is contained in:
Michael Miller 2018-11-02 14:32:36 -06:00
parent 61fe8e06d9
commit 6f5c269fcc
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -6,6 +6,16 @@ It provides more functionality from [RSpec](http://rspec.info/)
than the built-in Crystal [Spec](https://crystal-lang.org/api/latest/Spec.html) utility. than the built-in Crystal [Spec](https://crystal-lang.org/api/latest/Spec.html) utility.
Additionally, Spectator provides extra features to make testing easier and more fluent. Additionally, Spectator provides extra features to make testing easier and more fluent.
**Goal:**
Spectator is designed to:
- Reduce complexity of test code.
- Remove boilerplate from tests.
- Lower the difficulty of writing non-trivial tests.
- Provide an elegant syntax that is easy to read and understand.
- Provide common utilities that the end-user would otherwise need to write.
Installation Installation
------------ ------------
@ -65,12 +75,12 @@ end
If you find yourself trying to shoehorn in functionality If you find yourself trying to shoehorn in functionality
or unsure how to write a test, please create an [issue](https://gitlab.com/arctic-fox/spectator/issues/new) for it. or unsure how to write a test, please create an [issue](https://gitlab.com/arctic-fox/spectator/issues/new) for it.
We want to make it as easy as possible to write specs and keep it elegant. We want to make it as easy as possible to write specs and keep your code clean.
We may come up with a better solution or even introduce a feature to support your needs. We may come up with a solution or even introduce a feature to support your needs.
NOTE: Due to the way this shard uses macros, NOTE: Due to the way this shard uses macros,
you may find that some code you would expect to work, or works in other spec libraries, creates syntax errors. you may find that some code you would expect to work, or works in other spec libraries, creates syntax errors.
If you run into this, please create an issue so that we may help you find a solution. If you run into this, please create an issue so that we may help you resolve it.
Features Features
-------- --------