summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2017-07-16 18:56:48 +0200
committerEugen Wissner <belka@caraus.de>2017-07-16 18:56:48 +0200
commit9ef5986288172fd9505ec88e51dee839c7eab32f (patch)
tree61e0ee058dd2a81a417fb68b1e6d9463882f554a /README.md
parent42146c5e8a1352cd20f6ff32512c7cceb4472967 (diff)
downloadtanya-9ef5986288172fd9505ec88e51dee839c7eab32f.tar.gz
Add some style guidelines for contributors
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2a81782..549413c 100644
--- a/README.md
+++ b/README.md
@@ -19,9 +19,10 @@ data structures and utilities that depend on the Garbage Collector in Phobos.
* [Documentation](https://docs.caraus.io/tanya)
* [Contribution guidelines](CONTRIBUTING.md)
+
## Overview
-Tanya consists of the following packages:
+Tanya consists of the following packages and (top-level) modules:
* `async`: Event loop (epoll, kqueue and IOCP).
* `container`: Queue, Array, Singly and doubly linked lists, Buffers, UTF-8
@@ -29,8 +30,14 @@ string, Hash set.
* `format`: Formatting and conversion functions.
* `math`: Arbitrary precision integer and a set of functions.
* `memory`: Tools for manual memory management (allocators, smart pointers).
-* `net`: URL-Parsing, sockets, utilities.
+* `net`: URL-Parsing, network programming.
+* `network`: Socket implementation. `network` is currently under rework.
+After finishing the new socket implementation will land in the `net` package and
+`network` will be deprecated.
* `os`: Platform-independent interfaces to operating system functionality.
+* `typecons`: Templates that allow to build new types based on the available
+ones.
+
## Basic usage
@@ -125,6 +132,7 @@ int i = arr[7]; // Access 7th element.
There are more containers in the `tanya.container` package.
+
## Development
### Supported compilers
@@ -160,3 +168,9 @@ Deprecated features are removed after one release (in approximately 6 weeks afte
is being tested on Windows and FreeBSD as well.
* The library isn't thread-safe yet.
+
+
+## Feedback
+
+Any feedback about your experience with tanya would be greatly appreciated. Feel free to
+[contact me](mailto:info@caraus.de).