README.md in restspec-0.0.4 vs README.md in restspec-0.1
- old
+ new
@@ -9,11 +9,11 @@
$ gem install restspec
## Usage
-For a basic tutorial of how to use Restspec, please check [this file](https://github.com/platanus/restspec/blob/master/docs/tutorial.md).
+For a basic tutorial of how to use Restspec, please check [this file](https://github.com/platanus/restspec/blob/master/guides/tutorial.md).
### The Restspec Approach
You can skip this section but i think it will help you understand how things happens here. The Restspec design is founded in the separation of how your api components are modeled and what the actual tests are. In Restspec, you have three files intended to model your api:
@@ -70,11 +70,11 @@
get :show
end
end
```
-Check the endpoint DSL documentation [here](https://github.com/platanus/restspec/blob/master/docs/endpoints.md) for more details of the available methods and options. The only important thing about them is that they are the endpoints we have to test.
+Check the endpoint DSL documentation [here](https://github.com/platanus/restspec/blob/master/guides/endpoints.md) for more details of the available methods and options. The only important thing about them is that they are the endpoints we have to test.
### Schemas
Schemas are how your data is shaped and they enforces the shape of the your data and how to generates random examples for that. You can define schemas using a special dsl like this:
@@ -90,13 +90,13 @@
schema :category do
attribute :name, string
end
```
-As you can see, a schema is compound of attributes that are attached to one type. The types are useful for many things. The types documentation is located [here](https://github.com/platanus/restspec/blob/master/docs/types.md).
+As you can see, a schema is compound of attributes that are attached to one type. The types are useful for many things. The types documentation is located [here](https://github.com/platanus/restspec/blob/master/guides/types.md).
-The schemas DSL documentation is located [here](https://github.com/platanus/restspec/blob/master/docs/schemas.md). Schemas are a very important part of Restspec but they are not as necesary as the endpoints.
+The schemas DSL documentation is located [here](https://github.com/platanus/restspec/blob/master/guides/schemas.md). Schemas are a very important part of Restspec but they are not as necesary as the endpoints.
### Tests
To actually test something, let's create any test of type `api` (because in the `restspec/restspec_config` file we added helpers and macros only for this type of tests). To test an endpoint of your api you have to use the `endpoint` macro
@@ -153,11 +153,11 @@
end
end
end
```
-For more information about what can you do in your tests, you can see what are the [available matchers](https://github.com/platanus/restspec/blob/master/docs/matchers.md), the [available helpers](https://github.com/platanus/restspec/blob/master/docs/helpers.md) and the [available macros](https://github.com/platanus/restspec/blob/master/docs/macros.md).
+For more information about what can you do in your tests, you can see what are the [available matchers](https://github.com/platanus/restspec/blob/master/guides/matchers.md), the [available helpers](https://github.com/platanus/restspec/blob/master/guides/helpers.md) and the [available macros](https://github.com/platanus/restspec/blob/master/guides/macros.md).
### Requirements
They allow to check for something important before starting to test.
@@ -178,12 +178,16 @@
endpoint 'products/create' do
ensure! :check_warehouse_availability
end
```
-## A note about the Roadmap
+## If you have some issue
-Because the scope of this library is not small, we couldn't make a first release as small as we are acostumed. Anyway, we love to be able to deliver in small iterations, so there a [ROADMAP](https://github.com/platanus/restspec/blob/master/ROADMAP.md) file that we use to keep track of the objectives that we have. Althought many of the objectives of the gem are already done, there are more objectives that will expect to the following releases.
+Be sure to add your issue with a `bug` label or the `question` one.
+
+## A note about SemVer
+
+We are using SemVer from 0.0.4 onwards. Versions before 0.0.4 doesn't use Semver and they add some features (intended for MINOR releases, not for PATCH releases). With the addition of 0.0.5, we will be using a CHANGELOG.md file with the track of the commits that made their way to that version.
## Contribute
Please be sure to have the [EditorConfig](http://editorconfig.org/) plugin in your text editor to follow the guidelines proposed in the [.editorconfig](https://github.com/platanus/restspec/blob/master/.editorconfig) file. To contribute, please send us a PR and make sure that the current tests keeps working after that. You can help to complete the unit tests too.