Skip to content

Commit

Permalink
Use correct licence and add a documention index.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim-ats-d committed Dec 26, 2022
1 parent 28a3445 commit 96909fa
Show file tree
Hide file tree
Showing 6 changed files with 198 additions and 680 deletions.
827 changes: 159 additions & 668 deletions LICENSE

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion mehari-eio/mehari_eio.mli
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ val run :
[Eio.Net.Ipaddr.V4.loopback].
- [config] is the TLS server configuration.
Defaults to
{[
{@ocaml[
Tls.Config.server ~certificates
~authenticator:(fun ?ip:_ ~host:_ _ -> Ok None)
()
Expand Down
2 changes: 1 addition & 1 deletion mehari-mirage/mehari_mirage.mli
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ module type S = sig
write a request after TLS handshake. Unset by default.
- [config] is the TLS server configuration.
Defaults to
{[
{@ocaml[
Tls.Config.server ~certificates
~authenticator:(fun ?ip:_ ~host:_ _ -> Ok None)
()
Expand Down
3 changes: 3 additions & 0 deletions mehari/dune
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@
uri
x509
zed))

(documentation
(package mehari))
31 changes: 31 additions & 0 deletions mehari/index.mld
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{0 Mehari}

Mehari is a cross-platform library for building Gemini servers. It fully
implements the
{{:https://gemini.circumlunar.space/docs/specification.gmi} Gemini protocol specification}.
It takes heavy inspiration from {{:https://github.com/aantron/dream} Dream}, a
tidy, feature-complete Web framework.

Mehari provides several packages:

- {{:Mehari/index.html} Mehari} provides the core abstraction, it does not
depend on any platform code, and does not interact with the environment.

- {{:Mehari_mirage/index.html} Mehari_mirage} exposes an OS-independent
interface.

- {{:Mehari_lwt_unix/index.html} Mehari_lwt_unix} uses the
{{:https://ocsigen.org/lwt/} Lwt} library, and specifically the UNIX
bindings. Contains also extra features based on Unix filesystem such as
CGI.

- {{:Mehari_eio/index.html} Mehari_eio} uses the
{{:https://github.com/ocaml-multicore/eio} Eio} OCaml 5.0 library.

{1 Links}

- {{:https://github.com/Psi-Prod/Mehari} Mehari on Github}
- {{:https://github.com/Psi-Prod/Mehari/issues} Bugtracker}

The library is released under the
{{:https://github.com/Psi-Prod/Mehari/blob/master/LICENSE} LGPL-3.0 License}
13 changes: 3 additions & 10 deletions mehari/mehari.mli
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
(** Mehari is a {{:https://mirageos.org/ }Mirage OS} friendly library for
building Gemini servers. It fully implements the
{{:https://gemini.circumlunar.space/docs/specification.gmi }Gemini protocol specification}
and aims to expose a clean and simple API.
It takes heavy inspiration from {{: https://github.com/aantron/dream }Dream},
a tidy, feature-complete Web framework.
This module provides the core abstraction, it does not depend on any platform
code, and does not interact with the environment. Input and output for Unix are
provided by {!Mehari_lwt_unix}. *)
(** This module provides the core abstraction, it does not depend on any platform
code, and does not interact with the environment. *)

(** {1 Types} *)

Expand Down Expand Up @@ -145,7 +138,7 @@ val stream : ?flush:bool -> ((string -> unit) -> unit) -> body

val page : title:string -> string -> body
(** [page ~title content] creates a simple Gemtext {!type:body} of form:
{[
{@gemini[
# title
content
]}
Expand Down

0 comments on commit 96909fa

Please sign in to comment.