Skip to content

Commit

Permalink
docs: update description
Browse files Browse the repository at this point in the history
  • Loading branch information
seliopou committed Mar 30, 2017
1 parent 106c356 commit 3520f33
Show file tree
Hide file tree
Showing 7 changed files with 4,329 additions and 3,469 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Faraday

Faraday is a library of low-level primitives for writing serializers for
user-defined datatypes. Its primitives provide the user fine-grained control
over copying and allocation behavior, and presents serialization output in a
form that is suitable for use with vectorized writes via the [writev][] system
call or any other platform or application-specific output interfaces.
Faraday is a library for writing fast and memory-efficient serializers. Its
core type and related operation gives the user fine-grained control over
copying and allocation behavior while serializing user-defined types, and
presents the output in a form that makes it possible to use vectorized write
operations, such as the [writev][] system call, or any other platform or
application-specific output APIs.


[![Build Status](https://travis-ci.org/inhabitedtype/faraday.svg?branch=master)](https://travis-ci.org/inhabitedtype/faraday)

Expand Down
9 changes: 8 additions & 1 deletion _oasis
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ License: BSD-3-clause
Plugins: META (0.4), DevFiles (0.4)
BuildTools: ocamlbuild
OCamlVersion:>= 4.02
Synopsis: Serialization library built for speed and memory-efficiency
Synopsis: A library for writing fast and memory-efficient serializers.
Description:
Faraday is a library for writing fast and memory-efficient serializers. Its
core type and related operation gives the user fine-grained control over
copying and allocation behavior while serializing user-defined types, and
presents the output in a form that makes it possible to use vectorized
write operations, such as the writev system call, or any other platform or
application-specific output APIs.


Flag async
Expand Down
10 changes: 5 additions & 5 deletions lib/META
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OASIS_START
# DO NOT EDIT (digest: ab59c28122af5ac111219914acc302f6)
# DO NOT EDIT (digest: 9e3bce218cef899cb8c71404bb9e4802)
version = "dev"
description = "Serialization library built for speed and memory-efficiency"
description = "A library for writing fast and memory-efficient serializers."
requires = "bigarray ocplib-endian ocplib-endian.bigstring"
archive(byte) = "faraday.cma"
archive(byte, plugin) = "faraday.cma"
Expand All @@ -10,7 +10,7 @@ archive(native, plugin) = "faraday.cmxs"
exists_if = "faraday.cma"
package "lwt-unix" (
version = "dev"
description = "Serialization library built for speed and memory-efficiency"
description = "A library for writing fast and memory-efficient serializers."
requires = "faraday.lwt lwt.unix"
archive(byte) = "faraday_lwt_unix.cma"
archive(byte, plugin) = "faraday_lwt_unix.cma"
Expand All @@ -21,7 +21,7 @@ package "lwt-unix" (

package "lwt" (
version = "dev"
description = "Serialization library built for speed and memory-efficiency"
description = "A library for writing fast and memory-efficient serializers."
requires = "faraday lwt"
archive(byte) = "faraday_lwt.cma"
archive(byte, plugin) = "faraday_lwt.cma"
Expand All @@ -32,7 +32,7 @@ package "lwt" (

package "async" (
version = "dev"
description = "Serialization library built for speed and memory-efficiency"
description = "A library for writing fast and memory-efficient serializers."
requires = "async core faraday threads"
archive(byte) = "faraday_async.cma"
archive(byte, plugin) = "faraday_async.cma"
Expand Down
13 changes: 7 additions & 6 deletions lib/faraday.mli
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,13 @@

(** Serialization primitives built for speed an memory-efficiency.
Faraday is a library of low-level primitives for writing serializers for
user-defined datatypes. Its primitives provide the user fine-grained
control over copying and allocation behavior, and presents serialization
output in a form that is suitable for use with vectorized writes via the
[writev] system call or any other platform or application-specific output
subsystem.
Faraday is a library for writing fast and memory-efficient serializers. Its
core type and related operation gives the user fine-grained control over
copying and allocation behavior while serializing user-defined types, and
presents the output in a form that makes it possible to use vectorized
write operations, such as the [writev][] system call, or any other platform
or application-specific output APIs.
A Faraday serializer manages an internal buffer and a queue of output
buffers. The output bufferes may be a sub range of the serializer's
Expand Down
Loading

0 comments on commit 3520f33

Please sign in to comment.