status-im
/
nim-stew
mirror of https://github.com/status-im/nim-stew.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Jacek Sieka 2019-07-25 08:00:17 +02:00 committed by GitHub
parent ac62ce57f4
commit 700f21b54f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -16,6 +16,17 @@ battle-tested.
Some of these libraries may eventually be proposed for inclusion in Nim or
broken out into separate repositories.
## Notable libraries
Libraries are documented either in-module or on a separate README in their
respective folders
- `bitops2` - an updated version of `bitops.nim`, filling in gaps in original code
- `byteutils` - utilities that make working with the Nim `byte` type convenient
- `endians2` - utilities for converting to and from little / big endian integers
- `ranges` - utility functions for working with parts and blobs of memory
- `shims` - backports of nim `devel` code to the stable version that Status is using
## Layout
`stew` modules are made to be fairly independent of each other, but generally
@ -59,16 +70,6 @@ else
{.fatal: "unsupported nim version"}
```
## Notable libraries
Libraries are documented either in-module or on a separate README in their
respective folders
- `bitops2` - an updated version of `bitops.nim`, filling in gaps in original code
- `byteutils` - utilities that make working with the Nim `byte` type convenient
- `ranges` - utility functions for working with parts and blobs of memory
- `shims` - backports of nim `devel` code to the stable version that Status is using
## Using stew in your project
We do not recommend using this library as a normal `nimble` dependency - there