Skip to content

Commit e80d22b

Browse files
authored
Update README.md
Include section about the Matrix rooms.
1 parent 1a9119b commit e80d22b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Released under the terms of the [MIT LICENSE](LICENSE).
99
If you are thinking of using the *master* branch of this library in production, **stop**.
1010
Master is not stable; it is our development branch, and [only tagged releases may be classified as stable](https://github.com/bitcoinjs/bitcoinjs-lib/tags).
1111

12-
1312
## Can I trust this code?
1413
> Don't trust. Verify.
1514
@@ -23,12 +22,24 @@ Mistakes and bugs happen, but with your help in resolving and reporting [issues]
2322
- Standardized, using [prettier](https://github.com/prettier/prettier) and Node `Buffer`'s throughout, and
2423
- Friendly, with a strong and helpful community, ready to answer questions.
2524

26-
2725
## Documentation
2826
Presently, we do not have any formal documentation other than our [examples](#examples), please [ask for help](https://github.com/bitcoinjs/bitcoinjs-lib/issues/new) if our examples aren't enough to guide you.
2927

3028
You can find a [Web UI](https://bitcoincore.tech/apps/bitcoinjs-ui/index.html) that covers most of the `psbt.ts`, `transaction.ts` and `p2*.ts` APIs [here](https://bitcoincore.tech/apps/bitcoinjs-ui/index.html).
3129

30+
## How can I contact the developers outside of Github?
31+
**Most of the time, this is not appropriate. Creating issues and pull requests in the open will help others with similar issues, so please try to use public issues and pull requests for communication.**
32+
33+
That said, sometimes developers might be open to taking things off the record (ie. You want to share code that you don't want public to get help with it). In that case, please negotiate on the public issues as to where you will contact.
34+
35+
We have created public rooms on IRC (`#bitcoinjs` on `libera.chat`) and Matrix (`#bitcoinjs-dev:matrix.org`). These two channels have been joined together in a Matrix "Space" which has the Matrix room AND an IRC bridge room that can converse with the IRC room. The "Space" is `#bitcoinjs-space:matrix.org`.
36+
37+
Matrix and IRC both have functions for direct messaging, but IRC is not end to end encrypted, so Matrix is recommended for most communication. The official Matrix client maintained by the Matrix core team is called "Element" and can be downloaded here: https://element.io/download (Account creation is free on the matrix.org server, which is the default setting for Element.)
38+
39+
We used to have a Slack. It is dead. If you find it, no one will answer you most likely.
40+
41+
No we will not make a Discord.
42+
3243
## Installation
3344
``` bash
3445
npm install bitcoinjs-lib

0 commit comments

Comments
 (0)