Skip to content

Commit d96dbdf

Browse files
committed
Release stuff, install info
1 parent 4a843f7 commit d96dbdf

File tree

3 files changed

+33
-15
lines changed

3 files changed

+33
-15
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Documentation and examples can be found on the project's [Github Page](https://a
66

77
### Status
88

9-
Blueprint Datagrid is currently in active development. Progress is being tracked in [this project](https://github.com/users/alex-c/projects/1). There is no version of Blueprint Datagrid released on NPM yet.
9+
Blueprint Datagrid is currently in active development. Progress is being tracked in [this project](https://github.com/users/alex-c/projects/1). You can find the current version on [NPM](https://www.npmjs.com/package/@alex-c/blueprint-datagrid).
1010

1111
## Why
1212

@@ -26,4 +26,25 @@ More details and examples can be found in the [documentation](https://alex-c.git
2626

2727
## Getting Started
2828

29-
🚧 TODO 🚧
29+
Blueprint Datagrid can be installed using `npm` (or the package manager of your choice):
30+
31+
```
32+
npm install @alex-c/blueprint-datagrid
33+
```
34+
35+
In your `react` project, import and use the `Datagrid` component as well as other needed components:
36+
37+
```js
38+
import { Column, ColumnType, Datagrid, Pager } from "@alex-c/blueprint-datagrid";
39+
40+
//...
41+
42+
<Datagrid dataSource={varieties}>
43+
<Column field="name" label="Name" filter />
44+
<Column field="shuUpperBound" label="Heat (SHU)" type={ColumnType.NUMBER} sortable />
45+
<Column field="rare" label="Rare" type={ColumnType.BOOLEAN} />
46+
<Pager elementsPerPage={5} />
47+
</Datagrid>;
48+
```
49+
50+
You can find more information on how to use Blueprint Datagrid in the [documentation](https://alex-c.github.io/blueprint-datagrid/).

docs/src/pages/page-home.tsx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
import { Callout, Code, Intent, Tag } from "@blueprintjs/core";
1+
import { Code, Intent, Tag } from "@blueprintjs/core";
22
import { IconNames } from "@blueprintjs/icons";
33
import { Action, Column, ColumnType, Datagrid, Pager } from "../../../build";
44
import { useAppSelector } from "../app/hooks";
5+
import { CodeBlock } from "../components/code-block";
56
import { Example } from "../components/example";
67
import { Page } from "../components/page";
78
import { Section } from "../components/section";
@@ -83,9 +84,11 @@ export const HomePage = () => {
8384
</p>
8485
</Section>
8586
<Section title="Installation">
86-
<Callout icon={IconNames.WRENCH} intent={Intent.WARNING}>
87-
This section is work in progress!
88-
</Callout>
87+
<p>
88+
Install <strong>Blueprint Datagrid</strong> with <Code>npm</Code> (or the package manager of your choice):
89+
<br />
90+
<CodeBlock code="npm install @alex-c/blueprint-datagrid" />
91+
</p>
8992
</Section>
9093
<Section title="Usage">
9194
<p>

package.json

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@alex-c/blueprint-datagrid",
3-
"version": "0.1.0",
3+
"version": "0.3.2",
44
"description": "An enhanced table component for Blueprint 4.",
55
"main": "build/index.js",
66
"module": "build/index.es.js",
@@ -37,23 +37,17 @@
3737
},
3838
"homepage": "https://github.com/alex-c/blueprint-datagrid#readme",
3939
"dependencies": {
40-
"@blueprintjs/core": "^4.14.3",
41-
"@blueprintjs/icons": "^4.12.2",
42-
"@blueprintjs/popover2": "^1.11.3",
43-
"@blueprintjs/select": "^4.8.16",
4440
"@types/react": "^17.0.2",
4541
"@types/react-dom": "^17.0.2",
46-
"react": "^17.0.2",
47-
"react-dom": "^17.0.2",
4842
"typescript": "^4.6.3"
4943
},
5044
"peerDependencies": {
5145
"@blueprintjs/core": "^4.14.3",
5246
"@blueprintjs/icons": "^4.12.2",
5347
"@blueprintjs/popover2": "^1.11.3",
5448
"@blueprintjs/select": "^4.8.16",
55-
"react": "^17.0.2",
56-
"react-dom": "^17.0.2"
49+
"react": "^17.0.2 || 18",
50+
"react-dom": "^17.0.2 || 18"
5751
},
5852
"devDependencies": {
5953
"@rollup/plugin-commonjs": "^22.0.0",

0 commit comments

Comments
 (0)