Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README and setup.md #847

Open
wants to merge 4 commits into
base: v3
Choose a base branch
from
Open

Conversation

krulod
Copy link
Collaborator

@krulod krulod commented May 21, 2024

No description provided.

Copy link

stackblitz bot commented May 21, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
reatom ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2024 6:49am

@krulod krulod force-pushed the docs-improve-readme-and-setup branch from f8dd169 to 0994874 Compare May 22, 2024 06:48
@@ -5,107 +5,35 @@ sidebar:
order: 1
---

Reatom is a framework-agnostic state manager, and you can use it with various adapters for different frameworks. This guide provides a common usage with React.js, as it is the most commonly used view library currently.
Copy link
Collaborator

@Akiyamka Akiyamka May 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be left out, without this mention the examples on reatom give the false idea that reatom is only compatible with reatom


The base template project includes Vite, TypeScript, React and Reatom ecosystem: https://github.com/artalar/reatom-react-ts

You could try it online: [codesandbox](https://codesandbox.io/p/sandbox/github/artalar/reatom-react-ts/tree/main), [stackblitz](https://githubblitz.com/artalar/reatom-react-ts), [gitpod](https://gitpod.io/#https://github.com/artalar/reatom-react-ts)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this deleted?


```sh
npx degit github:artalar/reatom-react-ts PROJECT-NAME
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this deleted?

package.json Show resolved Hide resolved
Copy link
Collaborator

@Akiyamka Akiyamka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to leave all the changes regarding lit documentation, and put the rest in a separate MR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants