Skip to content

Commit

Permalink
Update README files (#3463)
Browse files Browse the repository at this point in the history
  • Loading branch information
prakhargupta1 authored Apr 29, 2024
1 parent b665b97 commit cd4b546
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/logo.svg" alt="Toolpad Studio logo"></a>
<a href="https://mui.com/toolpad/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/branding/product-toolpad-light.svg" alt="Toolpad Studio logo"></a>
</p>

<h1 align="center">Toolpad Studio</h1>

<div align="center">

Quickly build internal tools. Toolpad Studio is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.
Toolpad Studio is a self-hosted low-code admin builder designed to extend the [MUI](https://mui.com/) React components. It's for developers of all trades who want to save time building internal applications. Drag-and-drop from a catalogue of pre-built components, connect to any data source and build apps quickly.

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)

Expand All @@ -18,7 +18,7 @@ Quickly build internal tools. Toolpad Studio is a self-hosted low-code internal
-->

[![CircleCI](https://circleci.com/gh/mui/mui-toolpad/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/mui/mui-toolpad?branch=master)
[![Follow on Twitter](https://img.shields.io/twitter/follow/MUI_hq.svg?label=follow+MUI)](https://twitter.com/MUI_hq)
[![Follow on Twitter](https://img.shields.io/twitter/follow/Toolpad_.svg?label=follow+Toolpad)](https://twitter.com/Toolpad_)
[![Renovate status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/mui/mui-toolpad/issues/8)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui/mui-toolpad.svg)](https://isitmaintained.com/project/mui/mui-toolpad 'Average time to resolve an issue')
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mui-org)](https://opencollective.com/mui-org)
Expand Down Expand Up @@ -55,7 +55,8 @@ Check out our [documentation](https://mui.com/toolpad/studio/getting-started/).

## Examples

Check out our [mui-public](https://github.com/mui/mui-public) repo to see how a Toolpad Studio app looks in production.
Check out our [mui-public](https://tools-public.onrender.com/prod/pages/OverviewPage) app to see how a Toolpad Studio app looks in production.
Our documentation contains more [examples](https://mui.com/toolpad/studio/examples/) to help you get started.

## Contributing

Expand Down
30 changes: 26 additions & 4 deletions packages/toolpad-studio/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,37 @@
# @toolpad/studio
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/toolpad/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/branding/product-toolpad-light.svg" alt="Toolpad Studio logo"></a>
</p>

Low-code tool, powered by MUI
<h1 align="center">Toolpad Studio</h1>

Toolpad Studio is a self-hosted low-code admin builder designed to extend the [MUI](https://mui.com/) React components. It's for developers of all trades who want to save time building internal applications. Drag-and-drop from a catalogue of pre-built components, connect to any data source and build apps quickly.

## Installation

Install the package in your project directory with:

```bash
npm install @toolpad/studio
npx create-toolpad-app@latest my-toolpad-studio-app
# or
yarn create toolpad-app my-toolpad-studio-app
# or
pnpm create toolpad-app my-toolpad-studio-app
```

## Documentation

[The documentation](./docs)
Visit [https://mui.com/toolpad/studio/getting-started/](https://mui.com/toolpad/studio/getting-started/) to view the full documentation.

## Examples

Check out our [mui-public](https://tools-public.onrender.com/prod/pages/OverviewPage) app to see how a Toolpad Studio app looks in production.
Our documentation contains more [examples](https://mui.com/toolpad/studio/examples/) to help you get started.

## Changelog

The [changelog](https://github.com/mui/mui-toolpad/releases) is regularly updated to reflect what's changed in each new release.

## Roadmap

Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/toolpad/studio/getting-started/roadmap/).

0 comments on commit cd4b546

Please sign in to comment.