Skip to content

Commit

Permalink
v1
Browse files Browse the repository at this point in the history
  • Loading branch information
jschuler committed Jul 14, 2021
1 parent 0f90f55 commit 4c97687
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 18 deletions.
2 changes: 1 addition & 1 deletion packages/dev/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"serve": "serve public"
},
"dependencies": {
"@patternfly/quickstarts": "1.0.0-rc.30",
"@patternfly/quickstarts": "1.0.0",
"@patternfly/react-core": "^4.101.3",
"asciidoctor": "^2.2.1",
"react": "^16.14.0",
Expand Down
30 changes: 14 additions & 16 deletions packages/module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,27 @@ https://quickstarts.netlify.app/
## Install

```bash
yarn add @patternfly/quickstarts @patternfly/patternfly
or
npm install @patternfly/quickstarts @patternfly/patternfly
yarn add @patternfly/quickstarts
```

The package currently has these peer dependencies:
### Peer dependencies

If your project doesn't already have these installed, you'll need:
```bash
yarn add @patternfly/react-core [email protected]
```
"react": ">=16.8.0",
"react-dom": ">=16.8.0",
"@patternfly/patternfly": ">=4.90.5",
"@patternfly/react-core": ">=4.101.3"
"@patternfly/react-catalog-view-extension": ">=4.10.13"
```

### Stylesheets

In your web-apps entry point, add these stylesheets (these should be imported before modules from @patternfly/quickstarts are imported):

```js
import '@patternfly/patternfly/base/patternfly-shield-inheritable.css';
import '@patternfly/patternfly/patternfly.min.css';
import '@patternfly/patternfly/utilities/Accessibility/accessibility.css';
import '@patternfly/react-catalog-view-extension/dist/css/react-catalog-view-extension.css';
import '@patternfly/quickstarts/dist/quickstarts.css';
// base styles/variables for PatternFly-react
import '@patternfly/react-core/dist/styles/base.css';
// quick starts styles
import '@patternfly/quickstarts/dist/quickstarts.min.css';
// global bootstrap styles needed for quick starts
import '@patternfly/quickstarts/dist/quickstarts-bootstrap.min.css';
```

## Usage
Expand All @@ -44,7 +42,7 @@ import {
useLocalStorage,
QuickStartContextValues
} from '@patternfly/quickstarts';
// for how these yaml files should look see below
// for how these quick start yaml files should look see below
import quickstartOne from '.yamls/quickstart-one.yaml';
import quickstartTwo from '.yamls/quickstart-two.yaml';

Expand Down
2 changes: 1 addition & 1 deletion packages/module/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@patternfly/quickstarts",
"version": "1.0.0-rc.30",
"version": "1.0.0",
"description": "PatternFly quick starts",
"files": [
"dist"
Expand Down

0 comments on commit 4c97687

Please sign in to comment.