Skip to content

Commit

Permalink
docs(all): remove dependencies in install docs (#3009)
Browse files Browse the repository at this point in the history
  • Loading branch information
xelaint authored Aug 21, 2024
1 parent 81e649c commit ff4c14d
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions libs/analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
It simplifies event tracking and provides configuration options, such as defining analyzable actions. Notably, `@daffodil/analytics` focuses on handling state-related events and operates specifically on [`Actions`](https://ngrx.io/api/store/Action) from [`@ngrx/store`](https://ngrx.io/guide/store), rather than browser events. Additionally, it includes testing utilities tailored for analytics event tracking in Angular applications.

## Installation
To install `@daffodil/analytics` and its required dependencies, use the following commands in the terminal.
To install `@daffodil/analytics`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/auth @angular/common @angular/core @ngrx/store @ngrx/effects rxjs --save
npm install @daffodil/auth --save
```

Install with yarn:

```bash
yarn add @daffodil/auth @angular/common @angular/core @ngrx/store @ngrx/effects rxjs
yarn add @daffodil/auth
```

## Features
Expand Down
6 changes: 3 additions & 3 deletions libs/auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
`@daffodil/auth` manages the login and registration of users and their corresponding access tokens.

## Installation
To install `@daffodil/auth` and its dependencies, use the following commands in the terminal.
To install `@daffodil/auth`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/auth @angular/common @angular/core @daffodil/core @ngrx/store rxjs --save
npm install @daffodil/auth --save
```

Install with yarn:

```bash
yarn add @daffodil/auth @angular/common @angular/core @daffodil/core @ngrx/store rxjs
yarn add @daffodil/auth
```
2 changes: 1 addition & 1 deletion libs/authorizenet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To install `@daffodil/authorizenet`, use the following commands in the terminal.

Install with npm:
```
npm install @daffodil/authorizenet
npm install @daffodil/authorizenet --save
```

Install with yarn:
Expand Down
2 changes: 1 addition & 1 deletion libs/category/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To install `@daffodil/category`, use the following commands in the terminal.

Install with npm:
```bash
npm install @daffodil/category
npm install @daffodil/category --save
```

Install with yarn:
Expand Down
6 changes: 3 additions & 3 deletions libs/contact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
It supports drivers for a variety of ecommerce platforms, simplifying the process of integrating your UI with your platform's contact features. <!-- talk about supported platforms -->

## Installation
To install `@daffodil/contact` and its dependencies, use the following commands in the terminal.
To install `@daffodil/contact`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/contact @daffodil/core @ngrx/store @ngrx/effects --save
npm install @daffodil/contact --save
```

Install with yarn:

```bash
yarn add @daffodil/contact @daffodil/core @ngrx/store @ngrx/effects
yarn add @daffodil/contact
```

> After installing, an ecommerce platform driver needs to be set up. We highly recommend installing the [in-memory web api](./guides/drivers.md) for fast, out-of-the-box development.
Expand Down
4 changes: 2 additions & 2 deletions libs/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Building and maintaining a model and code for an ecommerce store is complex and
provides clear interfaces, models, and factories for the frontend of an ecommerce store so that you don't have to.

## Installation
To install `@daffodil/core`, use the following commands in the terminal.
To install `@daffodil/core`, use the following commands in your terminal.

Install with npm:
```
npm install @daffodil/core
npm install @daffodil/core --save
```

Install with yarn:
Expand Down
6 changes: 3 additions & 3 deletions libs/external-router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
It's useful when you are trying to generate "user-friendly" routes in external applications and want to resolve them by their "user-friendly" uri, like `sweatshirts`, instead of paths such as `category/6` or `category/sweatshirts`.

## Installation
To install `@daffodil/external-router` and its dependencies, use the following commands in the terminal.
To install `@daffodil/external-router`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/external-router @daffodil/core --save
npm install @daffodil/external-router --save
```

Install with yarn:
```bash
yarn add @daffodil/external-router @daffodil/core
yarn add @daffodil/external-router
```

## Usage
Expand Down
6 changes: 3 additions & 3 deletions libs/geography/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
`@daffodil/geography` provides platform-agnostic drivers for retrieving the list of available "regions" or "states" for a given country supported by a platform, along with useful models and functions for working with physical addresses.

## Installation
To install `@daffodil/geography` and its dependencies, use the following commands in your terminal.
To install `@daffodil/geography`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/geography @daffodil/core --save
npm install @daffodil/geography --save
```

Install with yarn:
```bash
yarn add @daffodil/geography @daffodil/core
yarn add @daffodil/geography
```

## Supported Platforms
Expand Down
4 changes: 2 additions & 2 deletions libs/navigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
Right now, `@daffodil/navigation` currently supports both a Magento driver and an in-memory driver (only outputs a shallow trees) for local development.

## Installation
To install `@daffodil/navigation`, use the following commands in the terminal.
To install `@daffodil/navigation`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/navigation
npm install @daffodil/navigation --save
```

Install with yarn:
Expand Down

0 comments on commit ff4c14d

Please sign in to comment.