chore: move root README.md to joint-core for npm, add symlink to it for github - Githubissues

clientIO / joint

A proven SVG-based JavaScript diagramming library powering exceptional UIs

https://jointjs.com

Mozilla Public License 2.0

4.73k stars 853 forks source link

chore: move root README.md to joint-core for npm, add symlink to it for github #2597

Closed zbynekstara closed 8 months ago

zbynekstara commented 8 months ago

Description

The root README.md file has good content, so it should be used on NPM (https://www.npmjs.com/package/@joint/core) as well as on Github (https://github.com/clientIO/joint).

This PR does the following:

Move README.md to packages/joint-core/README.md - this will be shown in NPM.
Add symlink to packages/joint-core/README.md as .github/README.md - this will redirect GitHub to use this file as the readme content of this repo (see https://stackoverflow.com/a/49981731/2263595)