Skip to content

Commit

Permalink
Test fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Acanguven committed Sep 10, 2019
1 parent bb76d2f commit c2b330d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
Micro frontend framework for scalable and blazing fast websites.

[![CircleCI](https://circleci.com/gh/puzzle-js/puzzle-js/tree/master.svg?style=svg)](https://circleci.com/gh/puzzle-js/puzzle-js/tree/master)
[![npm](https://img.shields.io/npm/dt/puzzle-microfrontends.svg)](https://www.npmjs.com/package/puzzle-microfrontends)
[![npm](https://img.shields.io/npm/v/puzzle-microfrontends.svg)](https://www.npmjs.com/package/puzzle-microfrontends)
[![npm](https://img.shields.io/npm/dt/puzzle-microfrontends.svg)](https://www.npmjs.com/package/@puzzle-js/core)
[![npm](https://img.shields.io/npm/v/puzzle-microfrontends.svg)](https://www.npmjs.com/package/@puzzle-js/core)
[![Known Vulnerabilities](https://snyk.io/test/github/puzzle-js/puzzle-js/badge.svg)](https://snyk.io/test/github/puzzle-js/puzzle-js)
[![codecov](https://codecov.io/gh/puzzle-js/puzzle-js/branch/master/graph/badge.svg)](https://codecov.io/gh/puzzle-js/puzzle-js)

Expand Down
14 changes: 7 additions & 7 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,25 +136,25 @@ Only gateway can decide if a fragment should be static or not.
To install PuzzleJs with Yarn or Npm, simply:

```bash
yarn add puzzle-microfrontends
yarn add @puzzle-js/core
```

```bash
npm install --save puzzle-microfrontends
npm install @puzzle-js/core
```

Then you can start using it

```js
const PuzzleJs = require('puzzle-microfrontends');
const PuzzleJs = require('@puzzle-js/core');
```

## Storefront
An example of starting storefront with simple configuration.

### Creating Storefront
```js
const Storefront = require('puzzle-microfrontends');
const Storefront = require('@puzzle-js/core');
const storefront = new Storefront({
port: 4444,
gateways: [{
Expand Down Expand Up @@ -346,19 +346,19 @@ Configurator is used for creating configuration for PuzzleJs with dependency inj

To create a storefront configurator:
```js
const { StorefrontConfigurator } = require('puzzle-microfrontends');
const { StorefrontConfigurator } = require('@puzzle-js/core');
const configurator = new StorefrontConfigurator();
```

To create a gateway configurator:
```js
const { GatewayConfigurator } = require('puzzle-microfrontends');
const { GatewayConfigurator } = require('@puzzle-js/core');
const configurator = new GatewayConfigurator();
```

Adding config and injecting into PuzzleJs
```js
const { GatewayConfigurator, Gateway } = require('puzzle-microfrontends');
const { GatewayConfigurator, Gateway } = require('@puzzle-js/core');
const configurator = new GatewayConfigurator();

configurator.config({
Expand Down
4 changes: 2 additions & 2 deletions docs/quick.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ module.exports = {
### 1.4 Create gateway configuration file.
*/index.js*
```js
const PuzzleJs = require('puzzle-microfrontends');
const PuzzleJs = require('@puzzle-js/core');
const path = require('path');

const gateway = new PuzzleJs.Gateway({
Expand Down Expand Up @@ -174,7 +174,7 @@ Your fragment will be available for preview at [http://localhost:4444/my-product
*/index.js*

```js
const PuzzleJs = require('puzzle-microfrontends');
const PuzzleJs = require('@puzzle-js/core');
const path = require('path');
const fs = require('fs');

Expand Down

0 comments on commit c2b330d

Please sign in to comment.