Update readme, bump packages

2024-10-29 12:57:12 -07:00
parent 5babdd8143
commit 5bb5e3342b
7 changed files with 27 additions and 17 deletions
@@ -10,3 +10,13 @@ This is a monorepo which is split into several different packages:
 - [@welshman/content](./packages/content) - utilities for parsing and rendering notes.
 - [@welshman/feeds](./packages/feeds) - an interpreter for custom nostr feeds.
 - [@welshman/dvm](./packages/dvm) - utilities for creating and making request against dvms.
+
+# Linking
+
+If you're developing an application which requires changes to welshman, you'll need to use `npm link` to link the two. This is an annoying process, and is only supported if using `npm`.
+
+- Clone welshman and the repository that depends on it
+- Within each `package` directory in welshman, run `npm link`
+- Within your application directory, link all welshman dependencies _simultaneously_ (or else only one will get linked. A command that does this is: `rm -rf node_modules; npm i; cat package.json|js '.depedencies|keys[]'|grep welshman|xargs npm link`.
+
+If you run `npm install` in your application directory, you'll need to repeat the final step above.