eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md (#1300)

Browse source 
Grammatical fix to documentation
This commit is contained in:
Teymour Aldridge 2020-06-06 05:30:16 +01:00 committed by GitHub
parent 85599b944c
commit 67cb564aef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -9,7 +9,7 @@ introduces the core features of servant. After this article, you should be able
to write your first servant webservices, learning the rest from the haddocks' to write your first servant webservices, learning the rest from the haddocks'
examples. examples.
The central documentation can be found [here](http://docs.servant.dev/). The core documentation can be found [here](http://docs.servant.dev/).
Other blog posts, videos and slides can be found on the Other blog posts, videos and slides can be found on the
[website](http://www.servant.dev/). [website](http://www.servant.dev/).
@ -51,9 +51,9 @@ To regenerate the script use (*note:* atm you need to comment `doc/cookbook/` pa
runghc ~/Documents/other-haskell/multi-ghc-travis/make_travis_yml_2.hs regenerate runghc ~/Documents/other-haskell/multi-ghc-travis/make_travis_yml_2.hs regenerate
``` ```
In case Travis jobs fail due failing build of dependency, you can temporarily In case Travis jobs fail due to a dependency failing to build, you can temporarily
add `constraints` to the `cabal.project`, and regenerate the `.travis.yml`. add `constraints` to the `cabal.project` file, and regenerate the `.travis.yml`.
For example, the following will disallow single `troublemaker-13.37` package version: For example, the following will disallow a single `troublemaker-13.37` package version:
``` ```
constraints: constraints:
@ -62,7 +62,7 @@ constraints:
## TechEmpower framework bechmarks ## TechEmpower framework bechmarks
We develop & maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/ We develop and maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/
To verify (i.e. compile and test that it works) To verify (i.e. compile and test that it works)
@ -82,4 +82,4 @@ To compare with `reitit` (Clojure framework)
./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune ./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune
``` ```
And visualise the results at https://www.techempower.com/benchmarks/#section=test You can see the visualised results at https://www.techempower.com/benchmarks/#section=test