Skip to content

Commit

Permalink
Consolidate README for sub packages (#4176)
Browse files Browse the repository at this point in the history
  • Loading branch information
luin committed May 6, 2024
1 parent c8c9832 commit d31ffa1
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 47 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Instantiate a new Quill object with a css selector for the div that should becom
```html
<!-- Include Quill stylesheet -->
<link
href="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.snow.css"
href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.snow.css"
rel="stylesheet"
/>

Expand All @@ -50,7 +50,7 @@ Instantiate a new Quill object with a css selector for the div that should becom
</div>

<!-- Include the Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.js"></script>
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.js"></script>

<!-- Initialize Quill editor -->
<script>
Expand All @@ -72,24 +72,24 @@ npm install quill

```html
<!-- Main Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.js"></script>
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.js"></script>

<!-- Theme included stylesheets -->
<link
href="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.snow.css"
href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.snow.css"
rel="stylesheet"
/>
<link
href="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.bubble.css"
href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.bubble.css"
rel="stylesheet"
/>

<!-- Core build with no theme, formatting, non-essential modules -->
<link
href="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.core.css"
href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.core.css"
rel="stylesheet"
/>
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.0/dist/quill.core.js"></script>
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.core.js"></script>
```

## Community
Expand Down
42 changes: 2 additions & 40 deletions packages/quill/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,3 @@
Note: This branch and README covers the upcoming 2.0 release. View [1.x docs here](https://github.com/quilljs/quill/tree/1.3.6).
# Quill

<h1 align="center">
<a href="https://quilljs.com/" title="Quill">Quill Rich Text Editor</a>
</h1>
<p align="center">
<a href="https://quilljs.com/" title="Quill"><img alt="Quill Logo" src="https://quilljs.com/assets/images/logo.svg" width="180"></a>
</p>
<p align="center">
<a title="Documentation" href="https://quilljs.com/docs/"><strong>Documentation</strong></a>
&#x2022;
<a title="Development" href="https://github.com/quilljs/quill/blob/master/.github/DEVELOPMENT.md"><strong>Development</strong></a>
&#x2022;
<a title="Contributing" href="https://github.com/quilljs/quill/blob/master/.github/CONTRIBUTING.md"><strong>Contributing</strong></a>
&#x2022;
<a title="Interactive Playground" href="https://quilljs.com/playground/"><strong>Interactive Playground</strong></a>
</p>
<p align="center">
<a href="https://github.com/quilljs/quill/actions" title="Build Status">
<img src="https://github.com/quilljs/quill/actions/workflows/main.yml/badge.svg" alt="Build Status">
</a>
<a href="https://npmjs.com/package/quill" title="Version">
<img src="https://img.shields.io/npm/v/quill.svg" alt="Version">
</a>
<a href="https://npmjs.com/package/quill" title="Downloads">
<img src="https://img.shields.io/npm/dm/quill.svg" alt="Downloads">
</a>
</p>

[Quill](https://quilljs.com/) is a modern rich text editor built for compatibility and extensibility. It was created by [Jason Chen](https://twitter.com/jhchen) and [Byron Milligan](https://twitter.com/byronmilligan) and actively maintained by [Slab](https://slab.com).

To get started, check out [https://quilljs.com/](https://quilljs.com/) for documentation, guides, and live demos!

## Community

Get help or stay up to date.

- [Contribute](https://github.com/quilljs/quill/blob/main/.github/CONTRIBUTING.md) on [Issues](https://github.com/quilljs/quill/issues)
- Follow [@jhchen](https://twitter.com/jhchen) and [@quilljs](https://twitter.com/quilljs) on Twitter
- Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/quill)
- If privacy is required, email support@quilljs.com
This is the main package of Quill.
3 changes: 3 additions & 0 deletions scripts/release.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ if (
exitWithError("Version mismatch between package.json and dist/package.json");
}

const readme = fs.readFileSync("README.md", "utf-8");
fs.writeFileSync(path.join(distFolder, "README.md"), readme);

exec(`npm publish --tag ${distTag}${dryRun ? " --dry-run" : ""}`, {
cwd: distFolder,
});
Expand Down

0 comments on commit d31ffa1

Please sign in to comment.