@movable/ui 0.3.1 → 0.4.0

package/README.md

@@ -12,24 +12,25 @@ This repo contains the shared components for our frontend applications. Using th
 2. Clone the repo
 3. `npm install` (note: `npm`, not `yarn`)
 
-### Linking to local Studio
+### Usage
 
+Ensure the project consuming this library has all the required peer dependencies.
+
+### Yarn Linking
+
+1. `@movable/ui`: `yarn link`
 1. `@movable/ui`: `npm run watch`
+1. `front-end/packages/studio`: `yarn link /path/to/local/@movable/ui`
+1. `front-end/packages/studio`: `yarn dev --force`
+1. Be sure afterwards to unlink from `front-end/packages/studio`: `yarn unlink @movable/ui`
 
-2. `front-end/packages/studio` (after making the change below): `yarn`, then `yarn dev`, `yarn test:dev`, or similar
+If yarn gets confused, try unlinking, removing `node_modules` and following the steps again.
 
-```js
-// front-end/packages/studio/package.json
+### NPM Linking
 
-{
-  // ...
-  "devDependencies": {
-    "@movable/ui": "link:./path/to/ui"
-    // ...
-  }
-  // ...
-}
-```
+tbd
+
+#### Linking to local Studio
 
 ## Conventional Commits
 

package/lib/components/index.d.ts

@@ -1 +1 @@
-export { DemoComponent } from "./DemoComponent";
+export { DemoComponent } from './DemoComponent';

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export { DemoComponent } from "./components";
-export { default as MovableUITheme } from "./theme";
+export { DemoComponent } from './components';
+export { default as MovableUITheme } from './theme';