Skip to content

Commit

Permalink
docs: update README.md and quickstart.md for beta launch
Browse files Browse the repository at this point in the history
  • Loading branch information
imtuanpham committed Aug 1, 2023
1 parent 1ba56df commit b3fc49f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Compose SDK is a Software Development Kit that enables a composable, code-driven

## What you need to know

- **Compose SDK is currently in Beta** - Packages, APIs, and anything else is bound to change
- **Compose SDK is currently in Beta** - Packages, APIs, and anything else are bound to change
- Compose SDK requires a Sisense license & access to a Sisense instance
- Compose SDK supports Sisense version L2022.11 or newer
- Compose SDK currently supports development using Typescript & React
- This repository is a monorepo containing all SDK packages. You can find the individual packages [here](https://github.com/orgs/sisense/packages?repo_name=compose-sdk-monorepo)

## Documentation

You can find documentation for Compose SDK on the [Sisense Developer Portal](https://www.sisense.dev).
You can find documentation for Compose SDK on the [Sisense Developer Portal](https://sisense.dev).

A demo application for Compose SDK + Typescript + React is available in: [compose-sdk-react-demo](https://github.com/sisense/compose-sdk-react-demo).

Expand Down Expand Up @@ -56,4 +56,4 @@ From `packages/sdk-ui`, run:
yarn storybook
```

You can find more information about setting up an app using this SDK in quickstart.md
You can find more information about setting up an app using this SDK in [quickstart.md](quickstart.md).
2 changes: 1 addition & 1 deletion quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ Your chart should look like this:
![Line chart rendered by the Chart component](./media/chart-data-source-example-2.png)
See the [SisenseContextProvider]([./functions/_sisense_sdk_ui.SisenseContextProvider.html](http://sisenseteam.gitlab-pages.sisense.com/compose-sdk-monorepo/functions/_sisense_sdk_ui.SisenseContextProvider.html)) and [Chart](http://sisenseteam.gitlab-pages.sisense.com/compose-sdk-monorepo//functions/_sisense_sdk_ui.Chart.html) docs for more details on supported props.
See the [API doc](https://sisense.dev/guides/sdk/) for more details on `SisenseContextProvider` and `Chart`.
## Next Steps
Expand Down

0 comments on commit b3fc49f

Please sign in to comment.