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

Fix some bad links in the guides

Browse Source
This commit is contained in:
Connor Prussin 2017-07-10 12:52:06 -07:00
parent 45b2dc69b6
commit 4408ad399d
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Contributing.md
View File

@ -39,13 +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 [docs](docs) directory. Please ensure all guides are written in live in the [Documentation](Documentation) directory. Please ensure all guides
markdown format, and all examples are fully-functional and implemented as are written in markdown format, and all examples are fully-functional and
self-contained subdirectories under [docs/examples](docs/examples). implemented as self-contained subdirectories
under [Documentation/Examples](Documentation/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

@ -13,7 +13,7 @@ production-ready yet. You can track what's left before it gets production-ready
by looking at by looking at
our [roadmap](https://github.com/cprussin/purescript-httpure/projects). If you'd our [roadmap](https://github.com/cprussin/purescript-httpure/projects). If you'd
like to help us get there quicker, please contribute! To get started, check like to help us get there quicker, please contribute! To get started, check
our [contributing guide](CONTRIBUTING.md). our [contributing guide](Contributing.md).
## Installation ## Installation
@ -50,8 +50,8 @@ on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
## Examples ## Examples
HTTPure ships with a number of [examples](docs/examples). To run an example, HTTPure ships with a number of [examples](Documentation/Examples). To run an
in the project root, run: example, in the project root, run:
```bash ```bash
make example EXAMPLE=<Example Name> make example EXAMPLE=<Example Name>
@ -71,7 +71,7 @@ make test
## Contributing ## Contributing
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).
## People ## People
@ -79,8 +79,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)