diff --git a/README.md b/README.md index 9b98e3dccf108617a09bdd639b410a6ca0347383..612b525666bdbe964f10601f9218d0135df4909e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,10 @@ Note: xpub is still _very_ new. This repository contains an initial set of components but is not yet ready for use. -## Installing - -In the root directory, run `npm install` then `npm run bootstrap` to install all the dependencies. - -Note: this monorepo uses Lerna, which works best with npm v4 when linking unpublished packages. Hoisting is not yet reliable, so each component has its own node_modules folder. - ## Contents ### PubSweet components -* `component-app`: a PubSweet component that provides an app container with nav bar. +* `component-app`: a PubSweet component that provides an app container with nav bar and journal provider. * `component-authentication`: a PubSweet component that provides authentication-related client pages. * `component-dashboard`: a PubSweet component that provides a Dashboard page. * `component-manuscript`: a PubSweet component that provides a Manuscript page. @@ -22,8 +16,18 @@ Note: this monorepo uses Lerna, which works best with npm v4 when linking unpubl ## xpub packages +* `xpub-edit`: WYSIWYG editors for use in xpub forms * `xpub-fonts`: fonts for use in xpub applications * `xpub-selectors`: some useful redux selectors * `xpub-styleguide`: components for use in react-styleguidist * `xpub-ui`: a library of user interface elements for use in PubSweet components. +## Installing + +In the root directory, run `npm install` then `npm run bootstrap` to install all the dependencies. + +Note: this monorepo uses Lerna, which works best with npm v4 when linking unpublished packages. Hoisting is not yet reliable, so each component has its own node_modules folder. + +## Running the app + +`cd packages/xpub-collabra && npm run start`