Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yurrriq committed Feb 2, 2021
1 parent def958f commit d22bc09
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

# elli #

Copyright (c) 2012-2016 Knut Nesheim, 2016-2018 elli-lib team
Copyright (c) 2012-2016 Knut Nesheim, 2016-2021 elli-lib team

__Version:__ 3.0.0
__Version:__ 4.0.0

__Authors:__ Knut Nesheim, elli-lib team.

Expand Down
21 changes: 11 additions & 10 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,31 @@
[![Hex.pm][hex badge]][hex package]
[![Documentation][doc badge]][docs]
[![Erlang][erlang badge]][erlang downloads]
[![Travis CI][travis badge]][travis builds]
![Common Test](https://github.com/elli-lib/elli/workflows/Common%20Test/badge.svg)
[![Coverage Status][coveralls badge]][coveralls link]
[![MIT License][license badge]](LICENSE)

[travis builds]: https://travis-ci.org/elli-lib/elli
[travis badge]: https://travis-ci.org/elli-lib/elli.svg
[hex badge]: https://img.shields.io/hexpm/v/elli.svg
[hex package]: https://hex.pm/packages/elli
[latest release]: https://github.com/elli-lib/elli/releases/latest
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A518.0-red.svg
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A520.0-red.svg
[erlang downloads]: http://www.erlang.org/downloads
[doc badge]: https://img.shields.io/badge/docs-edown-green.svg
[docs]: doc/README.md
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli/badge.svg?branch=develop
[coveralls link]: https://coveralls.io/github/elli-lib/elli?branch=develop
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli/badge.svg?branch=main
[coveralls link]: https://coveralls.io/github/elli-lib/elli?branch=main
[license badge]: https://img.shields.io/badge/license-MIT-blue.svg

Elli is a webserver you can run inside your Erlang application to
expose an HTTP API. Elli is a aimed exclusively at building
expose an HTTP API. Elli is aimed exclusively at building
high-throughput, low-latency HTTP APIs. If robustness and performance
is more important than general purpose features, then `elli` might be
for you. If you find yourself digging into the implementation of a
webserver, `elli` might be for you. If you're building web services,
not web sites, then `elli` might be for you.

Elli is used in production at Wooga and Game Analytics. Elli requires
OTP 18.0 or newer.
OTP 20.0 or newer.


## Installation
Expand All @@ -40,7 +38,10 @@ Add `elli` to your application by adding it as a dependency to your
[`rebar.config`](http://www.rebar3.org/docs/configuration):

```erlang
{deps, [elli]}.
{deps, [
%% ...
{elli, "4.0.0"}
]}.
```

Afterwards you can run:
Expand Down Expand Up @@ -302,4 +303,4 @@ about benchmarking HTTP servers.

Elli is licensed under [The MIT License](LICENSE).

Copyright (c) 2012-2016 Knut Nesheim, 2016-2018 elli-lib team
Copyright (c) 2012-2016 Knut Nesheim, 2016-2021 elli-lib team
4 changes: 2 additions & 2 deletions doc/overview.edoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@author Knut Nesheim
@author elli-lib team
@copyright 2012-2016 Knut Nesheim, 2016-2018 elli-lib team
@version 3.0.0
@copyright 2012-2016 Knut Nesheim, 2016-2021 elli-lib team
@version 4.0.0
@title elli
@doc Erlang web server for HTTP APIs

Expand Down

0 comments on commit d22bc09

Please sign in to comment.