Skip to content

Commit a7cfd5b

Browse files
committed
docs: add curve info to the readme
1 parent 6e2323e commit a7cfd5b

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ jobs:
8888
- name: Install Mac-OS Dependencies
8989
if: ${{ contains(matrix.os, 'macos') }}
9090
run: |
91-
brew install gnutls autoconf automake libtool
91+
brew install gnutls autoconf automake libtool
9292
9393
- uses: pnpm/action-setup@v4
9494
if: ${{ !matrix.dockerfile }}

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- High performance.
1212
- Fully usable with TypeScript (3+).
1313
- Compatible with Zeromq 4/5 via "zeromq/v5-compat"
14+
- Secure Curve protocol with Libsodium
1415

1516
## Useful links
1617

@@ -90,17 +91,24 @@ to start a build from source.
9091

9192
### Building from source
9293

93-
If a prebuilt binary is unavailable or if you want to pass certain options
94+
If a prebuilt binary is unavailable, or if you want to pass certain options
9495
during build, you can build this package from source.
9596

9697
Make sure you have the following installed before attempting to build from
9798
source:
9899

99100
- Node.js 10+ or Electron
100-
- A working C++17 compiler toolchain with make
101-
- Python 3 with Node 10+ (or legacy Python 2.7)
102-
- CMake 2.8+
103-
- curl
101+
- C++17 compiler toolchain (e.g. LLVM, GCC, MSVC)
102+
- Python 3
103+
- CMake 3.16+
104+
- vcpkg dependencies (e.g. on Linux it needs curl, unzip, zip, tar, git,
105+
pkg-config)
106+
107+
For Curve:
108+
109+
- automake
110+
- autoconf
111+
- libtool
104112

105113
To install from source, specify `build_from_source=true` in a `.npmrc` file
106114

@@ -118,14 +126,19 @@ When building from source, you can also specify additional build options in a
118126

119127
### Curve with Libsodium support
120128

121-
Enables CURVE security for encrypted communications. Zeromq uses libsodium for CURVE security. To enable CURVE support, add the following to your .npmrc:
129+
(Enabled by default)
130+
131+
Enables CURVE security for encrypted communications. Zeromq uses libsodium for
132+
CURVE security. To enable CURVE support, add the following to your .npmrc:
122133

123134
```ini
124135
zmq_curve="true"
125136
zmq_sodium="true"
126137
```
127138

128-
Building libsodium requires these dependencies on Linux/MacOS: `autoconf automake libtool`, which can be installed via `apt-get` or `brew`, etc.
139+
Building libsodium requires these dependencies on Linux/MacOS:
140+
`autoconf automake libtool`, which can be installed via `apt-get` or `brew`,
141+
etc.
129142

130143
#### Draft support
131144

0 commit comments

Comments
 (0)