Skip to content

Commit 81d6f5b

Browse files
committed
docs: edits readme
1 parent 5c42d59 commit 81d6f5b

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ SPDX-License-Identifier: Apache-2.0
4141
<h3 align="center">Weave.js</h3>
4242

4343
<p align="center">
44-
Build visual collaborative tools like Canva, Miro or Figma!
44+
Build online whiteboard applications like Excalidraw, Miro, Canva, or Figma!
4545
<br />
4646
<a href="https://github.com/InditexTech/weavejs-backend"><strong>Explore the docs »</strong></a>
4747
<br />
@@ -84,48 +84,58 @@ SPDX-License-Identifier: Apache-2.0
8484

8585
[![Weave.js Screen Shot][product-screenshot]](images/screenshot.png)
8686

87-
Weave.js is a powerful framework for building end-to-end visual collaborative applications, enabling real-time multi-user interactions on-the-fly. It provides robust synchronization based on Yjs and SyncedStore and provides an extensible API to streamline the development of interactive, collaborative applications.
87+
Weave.js is a powerful headless framework for building end-to-end collaborative whiteboard applications. Aimed at developers, it provides all the building blocks and plugins to develop visual collaborative canvas, as well as it handles user interactions in real time, so that changes in the visual canvas can be shared among multi users in real time.
88+
89+
It provides robust synchronization based on [Yjs][https://yjs.dev/] and [SyncedStore][https://syncedstore.org/docs/] as well as an extensible API to streamline the development of interactive, collaborative applications.
8890

8991
<p align="right">(<a href="#readme-top">back to top</a>)</p>
9092

9193
### Built With
9294

93-
- [Konva][Konva-url]
94-
- [Yjs][Yjs-url]
95-
- [SyncedStore][SyncedStore-url]
95+
- [Konva][https://konvajs.org/]
96+
- [Yjs][https://yjs.dev/]
97+
- [SyncedStore][https://syncedstore.org/docs/]
98+
99+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
100+
101+
### Related repositories
102+
103+
- [Weave.js][https://github.com/InditexTech/weavejs]
104+
- [Weave.js frontend][https://github.com/InditexTech/weavejs-frontend]
96105

97106
<p align="right">(<a href="#readme-top">back to top</a>)</p>
98107

99108
<!-- GETTING STARTED -->
100109

101110
## Getting Started
102111

103-
TODO
112+
Follow the [Quickstart documentation][docs-quick-start-url#backend] to create the backend server, which will handle all the real-time synchronization using a Weave.js Store provider, and to startup the backend server running on your local development environment.
113+
114+
Follow the [Weave.js documentation][docs-url] for details on setup instructions, usage guidelines, architecture details, and more.
115+
116+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
117+
118+
### Prerequisites
119+
120+
- macOS, Windows (WSL), or Linux.
121+
- Node.js 18.18.0 or later.
122+
- React 18.2.0 or less than 19.x.
104123

105124
<p align="right">(<a href="#readme-top">back to top</a>)</p>
106125

107126
<!-- ROADMAP -->
108127

109128
## Roadmap
110129

111-
TODO
130+
Check out [Weave.js roadmap][docs-roadmap-url] for details on planned work and the features that will come next.
112131

113132
<p align="right">(<a href="#readme-top">back to top</a>)</p>
114133

115134
<!-- CONTRIBUTING -->
116135

117136
## Contributing
118137

119-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
120-
121-
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
122-
Don't forget to give the project a star! Thanks again!
123-
124-
1. Fork the Project
125-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
126-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
127-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
128-
5. Open a Pull Request
138+
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.
129139

130140
<p align="right">(<a href="#readme-top">back to top</a>)</p>
131141

0 commit comments

Comments
 (0)