From 1d5a0a30d4e766d052827b3dbd54b413980e7e82 Mon Sep 17 00:00:00 2001 From: Quinn Dougherty Date: Thu, 28 Apr 2022 19:06:39 -0400 Subject: [PATCH] version increment; piggyback README.md improvements Value: [1e-5 to 6e-4] --- README.md | 18 ++++++++++++++---- packages/components/README.md | 21 +++++++++++++++++++-- packages/components/package.json | 2 +- 3 files changed, 34 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2f1de7f7..137fb1cb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ # Squiggle [![Packages check](https://github.com/quantified-uncertainty/squiggle/actions/workflows/ci.yml/badge.svg)](https://github.com/quantified-uncertainty/squiggle/actions/workflows/ci.yml) -[![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-lang.svg)](https://www.npmjs.com/package/@quri/squiggle-lang) -[![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg)](https://www.npmjs.com/package/@quri/squiggle-components) +[![npm version - lang](https://badge.fury.io/js/@quri%2Fsquiggle-lang.svg)](https://www.npmjs.com/package/@quri/squiggle-lang) +[![npm version - components](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg)](https://www.npmjs.com/package/@quri/squiggle-components) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/quantified-uncertainty/squiggle/blob/develop/LICENSE) [![codecov](https://codecov.io/gh/quantified-uncertainty/squiggle/branch/develop/graph/badge.svg?token=QRLBL5CQ7C)](https://codecov.io/gh/quantified-uncertainty/squiggle) -This is an experimental DSL/language for making probabilistic estimates. The full story can be found [here](https://www.lesswrong.com/s/rDe8QE5NvXcZYzgZ3). +_An estimation language_. + +## Get started + +- [Gallery](https://www.squiggle-language.com/docs/Discussions/Gallery) +- [Squiggle playground](https://squiggle-language.com/playground) +- [Language basics](https://www.squiggle-language.com/docs/Features/Language) +- [Squiggle functions source of truth](https://www.squiggle-language.com/docs/Features/Functions) +- [Known bugs](https://www.squiggle-language.com/docs/Discussions/Bugs) +- [Original lesswrong sequence](https://www.lesswrong.com/s/rDe8QE5NvXcZYzgZ3) +- [Author your squiggle models as Observable notebooks](https://observablehq.com/@hazelfire/squiggle) ## Our deployments @@ -27,7 +37,7 @@ the packages can be found in `packages`. - `@quri/squiggle-components` in `packages/components` contains React components that can be passed squiggle strings as props, and return a presentation of the result of the calculation. -- `@quri/squiggle-website` in `packages/website` The main descriptive website for squiggle, +- `packages/website` is the main descriptive website for squiggle, it is hosted at `squiggle-language.com`. The playground depends on the components library which then depends on the language. This means that if you wish to work on the components library, you will need to build (no need to bundle) the language, and as of this writing playground doesn't really work. diff --git a/packages/components/README.md b/packages/components/README.md index 282230d9..87c39ebe 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -1,8 +1,26 @@ +[![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg)](https://www.npmjs.com/package/@quri/squiggle-components) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/quantified-uncertainty/squiggle/blob/develop/LICENSE) + # Squiggle Components This package contains all the components for squiggle. These can be used either as a library or hosted as a [storybook](https://storybook.js.org/). -# Build for development +# Usage in a `react` project + +For example, in a fresh `create-react-app` project + +```sh +yarn add @quri/squiggle-components +``` + +Add to `App.js`: + +```sh +import {SquiggleEditor} from '@quri/squiggle-components'; + +``` + +# Build storybook for development We assume that you had run `yarn` at monorepo level, installing dependencies. @@ -24,6 +42,5 @@ yarn start And build artefacts for production, ```sh -yarn bundle # builds components library yarn build # builds storybook app ``` diff --git a/packages/components/package.json b/packages/components/package.json index 4a71a150..ac70581b 100644 --- a/packages/components/package.json +++ b/packages/components/package.json @@ -1,6 +1,6 @@ { "name": "@quri/squiggle-components", - "version": "0.2.13", + "version": "0.2.14", "license": "MIT", "dependencies": { "react-ace": "10.1.0",