semiotic 2.0.0-rc.2 → 2.0.0-rc.22

package/README.md

@@ -1,40 +1,43 @@
 [![Semiotic](semiotic_logo_horizontal.png "semiotic")](https://semiotic.nteract.io)
 
-[![Circle CI status](https://circleci.com/gh/nteract/semiotic/tree/master.svg?style=shield)](https://circleci.com/gh/nteract/semiotic/tree/master)
+[![Semiotic](https://github.com/nteract/semiotic/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/nteract/semiotic/actions/workflows/node.js.yml)
 
-Semiotic is a data visualization framework combining React & D3
+Semiotic is a data visualization framework combining React & D3.
 
-[Interactive Documentation](https://semiotic.nteract.io)
+## Documentation
 
-[API Docs on the wiki](https://semiotic.nteract.io/api)
+[Interactive Documentation v1.x](https://semioticv1.nteract.io/)
 
-[Examples](https://semiotic.nteract.io/examples)
+[API Docs v1.x](https://semioticv1.nteract.io/api)
 
-Installation
+[Interactive Examples v1.x](https://semioticv1.nteract.io/examples)
 
-```
-npm i semiotic
+[Preview of Interactive Documentation for v2.x](https://semiotic.nteract.io)
+
+## Installation
+
+```bash
+yarn install semiotic
 ```
 
-Example
+## Usage Example
 
+As a library:
 ```js
 import { XYFrame } from "semiotic"
 ```
 
-You can also use the static distribution:
+You can also use the static distribution (via https://unpkg.com or https://esm.sh):
 
-```
-https://unpkg.com/semiotic/dist/semiotic.min.js
+```html
+<script type="module">
+	import { XYFrame } from "https://unpkg.com/semiotic?module"
+</script>
 ```
 
-In which case the elements are exposed as properties of a `Semiotic` object:
-
-```js
-const { XYFrame } = Semiotic
-```
+[These Codepen examples](https://codepen.io/emeeks/) use the static distribution.
 
-This is how it's used in [these Codepen examples](https://codepen.io/emeeks/).
+## Project recognition
 
 _Semiotic icon based on an icon by André Schauer_
 
@@ -47,7 +50,21 @@ It may not be apparent in the commit logs but development of this library owes a
 * Shelby Sturgis
 * Tristan Reid
 
+## Testing
 
 Using BrowserStack for browser compatibility testing
+[![BrowserStack](browserstack_logo.png "browserstack")](http://browserstack.com/)
+
+## Changelog
+
+[Changelog](./CHANGELOG.md)
+
+## License
+
+[License](./LICENSE)
+
+## Contributing
+
+Our community follows the nteract [Contributor Code of Conduct](https://github.com/nteract/nteract/blob/main/CODE_OF_CONDUCT.md).
 
-[![BrowserStack](browserstack_logo.png "browserstack")](http://browserstack.com/) 
+If you are interested in contributing to the project, please read our [CONTRIBUTING.md](CONTRIBUTING.md) file.