Skip to content

Commit

Permalink
docs(readme): simplify contents
Browse files Browse the repository at this point in the history
  • Loading branch information
itsjavi committed Aug 23, 2023
1 parent 0d77a69 commit 74c8487
Showing 1 changed file with 22 additions and 43 deletions.
65 changes: 22 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/github/itsjavi/storylite?startScript=dev&installDependencies=true&title=StoryLite%20Example&file=packages/examples/react/stories/index.stories.tsx)

StoryLite is a modern and lightweight tool for developing and managing design systems and components. It is inspired by
the popular StoryBook UI and built on top of Vite⚡️, offering a streamlined and user-friendly experience.
StoryLite is a modern and lightweight toolkit for crafting and managing design systems and components
with ease. Inspired by the popular StoryBook UI and powered by Vite⚡️, StoryLite offers a streamlined and
familiar developer experience.

With StoryLite, individuals and teams can quickly create, test, and iterate on their UI components in isolation to
ensure consistency across the application.
With StoryLite, you can swiftly create, test, and refine UI components in isolation,
ensuring that your application maintains a consistent look and feel.

Designed for small projects that don't require all the features and complexity of a full-blown StoryBook setup,
StoryLite provides a familiar UI that is easy to use and customize to each team's unique needs.
Tailored for smaller projects that crave simplicity without the overhead of a full StoryBook setup,
StoryLite provides an intuitive UI that's customizable to your unique needs.

![StoryLite](https://raw.githubusercontent.com/itsjavi/storylite/main/packages/storylite/screenshot.png)

Expand Down Expand Up @@ -50,46 +51,24 @@ pnpm add -D @storylite/storylite vite @storylite/vite-plugin
For the next steps, please check the [example React](https://github.com/itsjavi/storylite/tree/main/packages/examples/react) directory
to learn how to integrate it in your project.

## Roadmap

### Features

- [ ] Addons:
- [ ] Different responsive sizes + custom size
- [ ] Zoom in/out
- [ ] Accessibility
- [ ] Multiple resizable viewports (side by side)
- [ ] Create `packages/examples` packages
- [x] Support React
- [ ] Support other frameworks like Vue, Svelte, Solid, and Qwik.
- Customizable components (props, styles, etc.)

### Technical

- [ ] Provide documentation (`packages/docs`)
- [ ] Use Nextra https://nextra.site/
- [ ] Host in GitHub Pages (build and deploy via GitHub Actions)
- [ ] Better handling of the iframes
- [ ] Better addons API
- [ ] Use redux-toolkit or similar (Zustand?)
- [ ] SSR/SSG frameworks support (Next, Astro, etc)
- [ ] Stories format compatible with Storybook (backwards compatible with SB v6 and v7)
- [ ] Better mobile experience (specially for sidebars and toolbars)
- [ ] Use Panda CSS
- [ ] Bundle entirely with `tsup`

## Current Limitations

- Currently, there is no support for things such as "auto docs", "code snippets", "knobs", "controls", "actions"
or "events".
- It has only been tested with React components, but it could potentially work with any framework that Vite supports. Support
and/or fixes for Vue, Svelte, Solid, and others is welcome via PRs.
- No support for MDX files, to keep the project simple, but adding support via PRs is welcome as long as it doesn't
add too much complexity.
## Current Focus and Future

While StoryLite is geared towards React components at the moment,
the potential exists for broader compatibility with other frameworks supported by Vite.
We're continuously enhancing the tool and looking to:

- Better story interoperability with StoryBook and Ladle.
- Better extensibility and configuration options.
- Expand addons to support multiple resizable viewports, and tools for zoom, accessibility, etc.
- Extend examples to frameworks like Vue, Svelte, Solid, and Qwik.
- Ability to generate code snippets for each story.
- Ability to edit component props and state in the UI.
- Improve documentation and mobile experience of the UI.
- Full test coverage.

## Contributing

Contributions are welcome! Please read the [contributing guidelines](https://github.com/itsjavi/storylite/tree/main/CONTRIBUTING.md) before submitting a PR.
Contributions are encouraged; Please check out our [contributing guidelines](https://github.com/itsjavi/storylite/tree/main/CONTRIBUTING.md) before submitting a PR.

## License

Expand Down

0 comments on commit 74c8487

Please sign in to comment.