2017-05-25 19:12:29 +00:00
|
|
|
# HTTPure
|
|
|
|
|
|
|
|
|
|
A purescript HTTP server framework.
|
|
|
|
|
|
|
|
|
|
## Status
|
|
|
|
|
|
|
|
|
|
This project is currently an early-stage work in progress. It is not
|
|
|
|
|
production-ready yet. You can track what's left before it gets production-ready
|
2017-05-25 19:16:32 +00:00
|
|
|
by looking at
|
|
|
|
|
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
|
2017-05-25 19:12:29 +00:00
|
|
|
our [contributing guide](CONTRIBUTING.md).
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bower install purescript-httpure
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
Module documentation is published
|
|
|
|
|
on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
|
|
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
We have a Makefile that wraps all commands for development. To run the test
|
|
|
|
|
suite, in the project root run:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
We are open to accepting contributions! Please see
|
|
|
|
|
the [contributing guide](CONTRIBUTING.md).
|
|
|
|
|
|
|
|
|
|
## People
|
|
|
|
|
|
|
|
|
|
HTTPure is written and maintained
|
|
|
|
|
by [Connor Prussin](https://connor.prussin.net).
|
|
|
|
|
|
|
|
|
|
We are open to accepting contributions! Please see
|
|
|
|
|
the [contributing guide](CONTRIBUTING.md).
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
[MIT](LICENSE)
|
