Browse Source

update packages section in README

Klaudiusz Dembler 4 years ago
parent
commit
4d9022d43a
1 changed files with 2 additions and 23 deletions
  1. 2 23
      README.md

+ 2 - 23
README.md

@@ -22,30 +22,9 @@ To run tests (Currently WIP) run:
 $ yarn test
 ```
 
-## Packages
+## Shared folder
 
-This repo is managed with [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/)
-
-To run a command in a workspace:
-
-```bash
-$ yarn workspace YOUR_WORKSPACE_NAME YOUR_COMMAND
-```
-
-For example, to add `react-spring` to `atlas-app`:
-
-```bash
-$ yarn workspace atlas-app add react-spring
-```
-
-### App package
-
-The app package is located under `./packages/app` and is where the actual Atlas application lives.
-Business logic, full pages and data fetching should all reside here.
-
-### Shared folder
-
-Historically, Atlas codebase was split between two packages - `app` and `@joystream/components`. Due to build process and developer experience issues it was decided to merge those packages into one until the separation is actually needed. Hence the `shared` directory under `app/src`. This folder is what used to be `@joystream/components` and it's intended to be application-agnostic. That means no Atlas-specific logic (like routing) should be put there, only atomic UI components.
+Historically, Atlas codebase was split between two packages - `app` and `@joystream/components`. Due to build process and developer experience issues it was decided to merge those packages into one until the separation is actually needed. Hence the `shared` directory in `src`. This folder is what used to be `@joystream/components` and it's intended to be application-agnostic. That means no Atlas-specific logic (like routing) should be put there, only atomic UI components.
 
 ## Deploy Previews