|
6 | 6 | </p>
|
7 | 7 | <br />
|
8 | 8 |
|
9 |
| -# RDKit for JavaScript (Official) |
| 9 | +# RDKit for JavaScript (Official) <!-- omit in toc --> |
10 | 10 |
|
11 | 11 | [](https://dev.azure.com/rdkit-js/rdkit-js/_build/latest?definitionId=1&branchName=master)
|
12 | 12 | [](https://github.com/rdkit/rdkit-js/blob/master/LICENSE)
|
|
17 | 17 | [](https://www.npmjs.com/package/@rdkit/rdkit)
|
18 | 18 | [](https://www.npmjs.com/package/@rdkit/rdkit)
|
19 | 19 |
|
20 |
| -## Table of contents |
21 |
| - |
22 |
| -- [RDKit for JavaScript (Official)](#rdkit-for-javascript-official) |
23 |
| - - [Table of contents](#table-of-contents) |
24 |
| - - [Introduction](#introduction) |
25 |
| - - [What is the scope of this repository](#what-is-the-scope-of-this-repository) |
26 |
| - - [What is NOT the scope of this repository](#what-is-not-the-scope-of-this-repository) |
27 |
| - - [Install](#install) |
28 |
| - - [Usage](#usage) |
29 |
| - - [Using RDKit.js package assets](#using-rdkitjs-package-assets) |
30 |
| - - [Option 1: Use the npm package distribution files](#option-1-use-the-npm-package-distribution-files) |
31 |
| - - [Option 2: Use the remote distribution files from unpkg.com](#option-2-use-the-remote-distribution-files-from-unpkgcom) |
32 |
| - - [Running RDKit.js in your JavaScript code](#running-rdkitjs-in-your-javascript-code) |
33 |
| - - [Using RDKit.js with JavaScript](#using-rdkitjs-with-javascript) |
34 |
| - - [Using RDKit.js with React.js](#using-rdkitjs-with-reactjs) |
35 |
| - - [Contributing](#contributing) |
36 |
| - - [NPM Releases](#npm-releases) |
37 |
| - - [Important note on npm versioning](#important-note-on-npm-versioning) |
38 |
| - - [Website deployments](#website-deployments) |
39 |
| - - [Maintainers](#maintainers) |
| 20 | +## Table of contents <!-- omit in toc --> |
| 21 | + |
| 22 | +- [Introduction](#introduction) |
| 23 | +- [Install](#install) |
| 24 | +- [Usage](#usage) |
| 25 | +- [Contributing](#contributing) |
| 26 | +- [Release process](#release-process) |
| 27 | +- [Website deployment](#website-deployment) |
| 28 | +- [Maintainers](#maintainers) |
40 | 29 |
|
41 | 30 | ## Introduction
|
42 | 31 |
|
@@ -135,7 +124,7 @@ To contribute to the plain javascript examples, read [this sub-repository README
|
135 | 124 |
|
136 | 125 | To contribute to the React.js examples, read [this sub-repository README](https://github.com/rdkit/rdkit-js/tree/master/examples/react).
|
137 | 126 |
|
138 |
| -## NPM Releases |
| 127 | +## Release process |
139 | 128 |
|
140 | 129 | NPM releases are currently semi-automated with the following azure pipeline:
|
141 | 130 |
|
@@ -171,7 +160,7 @@ With this in mind, we will attempt the following versioning scheme of the packag
|
171 | 160 | > Example: when a bug fix is made in a React component built on top of RDKit for version 2022.03.3, a new npm release `2022.03.3-1.0.1` will be published.
|
172 | 161 | > Example: when a new React component is built on top of RDKit for version 2022.03.3, a new npm release `2022.03.3-1.1.0` will be published.
|
173 | 162 |
|
174 |
| -## Website deployments |
| 163 | +## Website deployment |
175 | 164 |
|
176 | 165 | Website deployments for [rdkitjs.com](https://rdkitjs.com) are automated via [Vercel](https://vercel.com/) for each commit merged or pushed to the master branch.
|
177 | 166 |
|
|
0 commit comments