Skip to content

Commit ac98719

Browse files
committed
[docs] Slightly cleans home README
1 parent 6b34d94 commit ac98719

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,18 @@ It is currently under active developments, so features can evolve quite quickly.
88

99
You can read more about the intent of this project on the [Gephi blog](https://gephi.wordpress.com/2022/11/15/gephi-lite/).
1010

11-
This repository is the [monorepo](https://en.wikipedia.org/wiki/Monorepo) containing Gephi Lite, as well as other satellite packages:
12-
13-
- **[@gephi/gephi-lite-sdk](packages/broadcast)** contains core Gephi Lite types and utils
14-
- **[@gephi/gephi-lite-broadcast](packages/broadcast)** exports TypeScript helpers to control a Gephi Lite instance in another tab or frame, from other web application
15-
1611
## License
1712

1813
Gephi Lite source code is distributed under the [GNU General Public License v3](http://www.gnu.org/licenses/gpl.html).
1914

15+
## Repository structure
16+
17+
The codebase is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo):
18+
19+
- **[packages/gephi-lite](packages/gephi-lite)** contains core Gephi Lite types and utils
20+
- **[packages/sdk](packages/sdk) ([`@gephi/gephi-lite` on NPM](https://www.npmjs.com/package/@gephi/gephi-lite))** contains core Gephi Lite types and utils
21+
- **[packages/broadcast](packages/broadcast) ([`@gephi/gephi-lite-sdk` on NPM](https://www.npmjs.com/package/@gephi/gephi-lite-sdk))** exports TypeScript helpers to control a Gephi Lite instance in another tab or frame, from other web application
22+
2023
## Run locally
2124

2225
Gephi Lite is a web application, written using [TypeScript](https://www.typescriptlang.org/) and [React](https://react.dev/). The styles are written using [SASS](https://sass-lang.com/), and are based on [Bootstrap v5](https://getbootstrap.com/).

0 commit comments

Comments
 (0)