Skip to content

Commit 6cd8355

Browse files
committed
Add README.md to project
1 parent f0f28e2 commit 6cd8355

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Node.js crypto (ncrypto) library
2+
3+
The `ncrypto` library extracts the base internal implementation of Node.js crypto operations
4+
that support both `node:crypto` and Web Crypto implementations and makes them available for
5+
use in other projects that need to emulate Node.js' behavior.
6+
7+
## Compatibility
8+
9+
* Build systems: `ncrypto` can be built with either Bazel or CMake.
10+
* SSL libraries: `ncrypto` supports linking to either `boringssl` or `openssl`.
11+
12+
## Build flags
13+
14+
* Bazel: `--@ncrypto//:bssl_libdecrepit_missing=True`
15+
* CMake: `-DNCRYPTO_BSSL_LIBDECREPIT_MISSING=1`
16+
17+
If linking against `boringssl`, libdecrepit is an optional component that isn't always built. If
18+
this option is set, `ncrypto` will use a built-in replacement for the missing functions.

0 commit comments

Comments
 (0)