thunderstrike/purescript-httpurple
thunderstrike/purescript-httpurple
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor docs update

Browse Source
This commit is contained in:
Connor Prussin 2017-10-26 13:28:47 -07:00
parent d12830b2e4
commit f28a9bfed7
3 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Contributing.md
View File

@ -39,14 +39,14 @@ this end, documentation should mostly be provided inline in the codebase, and
should follow the same PR process as other commits. should follow the same PR process as other commits.
We also welcome documentation in the form of guides and examples. These should We also welcome documentation in the form of guides and examples. These should
live in the [Documentation](docs) directory. Please ensure all guides are live in the [Documentation](./docs) directory. Please ensure all guides are
written in markdown format, and all examples are fully-functional and written in markdown format, and all examples are fully-functional and
implemented as self-contained subdirectories implemented as self-contained subdirectories
under [Documentation/Examples](docs/Examples). under [Documentation/Examples](./docs/Examples).
All examples should have corresponding integration tests, to ensure that All examples should have corresponding integration tests, to ensure that
examples we promote remain functional. If you plan to contribute examples, examples we promote remain functional. If you plan to contribute examples,
please take a look at [IntegrationSpec.purs](Test/HTTPure/IntegrationSpec.purs). please take a look at [IntegrationSpec.purs](./test/HTTPure/IntegrationSpec.purs).
### Code ### Code

12
Readme.md
View File

@ -24,7 +24,7 @@ signatures are _mostly_ stable, but are subject to change before the 1.0 release
if there's a good reason to change them. if there's a good reason to change them.
If you'd like to help us get to 1.0 quicker, please contribute! To get started, If you'd like to help us get to 1.0 quicker, please contribute! To get started,
check our [contributing guide](Contributing.md). check our [contributing guide](./Contributing.md).
## Installation ## Installation
@ -54,10 +54,12 @@ main =
Module documentation is published Module documentation is published
on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure). on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
You can also take a look at [our guides](./docs).
## Examples ## Examples
HTTPure ships with a number of [examples](docs/Examples). To run an example, in HTTPure ships with a number of [examples](./docs/Examples). To run an example,
the project root, run: in the project root, run:
```bash ```bash
make example EXAMPLE=<Example Name> make example EXAMPLE=<Example Name>
@ -85,8 +87,8 @@ HTTPure is written and maintained
by [Connor Prussin](https://connor.prussin.net). by [Connor Prussin](https://connor.prussin.net).
We are open to accepting contributions! Please see We are open to accepting contributions! Please see
the [contributing guide](Contributing.md). the [contributing guide](./Contributing.md).
## License ## License
[MIT](License) [MIT](./License)

7
Releasing.md
View File

@ -3,7 +3,7 @@
1. Check out the release series branch (or `master` if you are releasing the 1. Check out the release series branch (or `master` if you are releasing the
next major/minor version). Ensure all relevant commits and PRs have been next major/minor version). Ensure all relevant commits and PRs have been
merged. merged.
2. Update [History.md](History.md) by changing "unreleased" to the new 2. Update [History.md](./History.md) by changing "unreleased" to the new
version/date. Example diff: version/date. Example diff:
```diff ```diff
-unreleased -unreleased
@ -11,11 +11,12 @@
+1.0.0 / 2017-07-10 +1.0.0 / 2017-07-10
+================== +==================
``` ```
3. Commit your update to [History.md](History.md). Use the message `Release 3. Commit your update to [History.md](./History.md). Use the message `Release
notes for v<new version number>`. notes for v<new version number>`.
4. Run `pulp version` in the project root. This will check the project for any 4. Run `pulp version` in the project root. This will check the project for any
issues and create a new version tag and empty checkpoint commit. issues and create a new version tag and empty checkpoint commit.
5. Push the release notes and version commit and version tag. 5. Push the release notes and version commit and version tag.
6. If you are pushing a non-patch release, create and push a branch named with 6. If you are pushing a non-patch release, create and push a branch named with
the version series, i.e. `v0.1.x`. the version series, i.e. `v0.1.x`.
7. [Create the release on github](https://github.com/cprussin/purescript-httpure/releases/new). 7. [Create the release on
github](https://github.com/cprussin/purescript-httpure/releases/new).