diff --git a/CHANGELOG.md b/CHANGELOG.md index bc7c4b887..53dd0d888 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,8 @@ - ignore ratelimits for bots #3439 - remove `msgs_mdns` references to deleted messages during housekeeping #3387 - format message lines starting with `>` as quotes #3434 -- node: remove `split2` dependency +- node: remove `split2` dependency #3418 +- node: add git installation info to readme #3418 ### Fixes - set a default error if NDN does not provide an error diff --git a/node/README.md b/node/README.md index 81710694c..2cb902edd 100644 --- a/node/README.md +++ b/node/README.md @@ -60,6 +60,19 @@ building from source or clone this repository and follow this steps: > not inside this folder. (We need this in order to include the rust source > code in the npm package.) +### Use a git branch in deltachat-desktop + +You can directly install a core branch, but make sure: +- that you have typescript in your project dependencies, as it is likely required +- you know that there are **no prebuilds** and so it's build during instalation which is why it takes so long + +``` +npm install https://github.com/deltachat/deltachat-core-rust.git#branch +``` + +If you want prebuilds for a branch that has a core pr, you might find an npm tar.gz package for that branch at . +The github ci also posts a link to it in the checks for each pr. + ### Use build-from-source in deltachat-desktop If you want to use the manually built node bindings in the desktop client (for