update READMEs (#1407)

* update READMEs

* move npm commands to yarn

* tweak working

* changeset

.changeset/giant-pants-build.md

@@ -0,0 +1,11 @@
+---
+"@khanacademy/kas": patch
+"@khanacademy/kmath": patch
+"@khanacademy/math-input": patch
+"@khanacademy/perseus-error": patch
+"@khanacademy/perseus-linter": patch
+"@khanacademy/pure-markdown": patch
+"@khanacademy/simple-markdown": patch
+---
+
+Updates to README files

README.md

@@ -25,7 +25,7 @@ This repo is a constellation of sub-repos for showing exercise content. Please s
 
 To install Perseus, you need to run the following commands:
 
-#### `yarn install`
+#### `yarn`
 
 Installs project dependencies and tooling
 

packages/kas/README.md

@@ -1,11 +1,9 @@
-KAS
-===
+# @khanacademy/kas
 
 A lightweight JavaScript CAS (Computer Algebra System) for comparing expressions and equations.
 It is used throughout [Khan Academy](https://khanacademy.org)'s interactive exercises.
 
-What can it do?
----------------
+## What can it do?
 
 It can parse plain text math, LaTeX, or a mix of both:
 
@@ -77,18 +75,15 @@ expr.simplify().print();
 // "(-1+3*p)^(-1)*(3*n+-1*m+2*p)"
 ```
 
-How to build the library
-------------------------
-    npm install
-    npm run build
+## How to build the library
+    yarn
+    yarn build
 
-How to build the parser
------------------------
+## How to build the parser
 First, make any changes in `src/parser-generator.js`
 
-    npm install
-    npm run build:parser
+    yarn
+    yarn build:parser
 
-License
--------
+## License
 [MIT License](http://opensource.org/licenses/MIT)

packages/kmath/README.md

@@ -1,7 +1,6 @@
-<h1 align="center">
-    <img alt="kmath" src="logo.svg" width="50" /> <br />
-    kmath - Javascript Numeric Math Utilities
-</h1>
+# @khanacademy/kmath
+
+Javascript Numeric Math Utilities
 
 ## Overview
 
@@ -34,7 +33,7 @@ pure and allocates a new array for the return value.
 ## Getting started
 
 After cloning or downloading kmath, you can install it by running
-`npm install` or `make install`.
+`yarn` or `make install`.
 
 To play around with the available interfaces, you can load kmath
 into a Node repl:

packages/math-input/README.md

@@ -1,6 +1,6 @@
-# math-input
+# @khanacademy/math-input
 
-Khan Academy's expression editor for the mobile web. Used in the [Perseus](https://github.com/khan/perseus) exercise framework to power math input and expression editing on small screens.
+Khan Academy's expression editor for the web. Used in the [Perseus](https://github.com/khan/perseus) exercise framework to power math input and expression editing on all screens.
 
 Built with [React](https://github.com/facebook/react), [MathQuill](https://github.com/mathquill/mathquill), [Aphrodite](https://github.com/khan/aphrodite), and more.
 
@@ -11,7 +11,7 @@ Try it yourself on [Khan Academy](https://www.khanacademy.org/math/algebra-basic
 ## Getting started
 
 - Clone the project: `git clone [email protected]:Khan/math-input.git`
-- Install dependencies: `yarn install`
+- Install dependencies: `yarn`
 - Start the development server: `yarn start`
 
 When you start the project you'll need to be on a device that supports touch or touch emulation to see the keyboard. The easiest way to get started is open the developer tools on Google Chrome.

packages/perseus-error/README.md

@@ -0,0 +1,5 @@
+# @khanacademy/perseus-error
+
+Shared PerseusError class for errors, meant to be used throughout Perseus.
+
+TODO: maybe this could be part of `@khanacademy/perseus-core`?

packages/perseus-linter/README.md

@@ -0,0 +1,7 @@
+# @khanacademy/perseus-linter
+
+> It’s to Perseus JSON what ESLint is to Javascript.
+>
+> \- Jeremy, on the role of perseus-linter
+
+A set of linting rules to help content creators use Perseus. Finds common pitfalls and lets editors know.

packages/pure-markdown/README.md

@@ -0,0 +1,7 @@
+# @khanacademy/pure-markdown
+
+An extended version of `@khanacademy/simple-markdown`, `pure-markdown` is a Node-compatible wrapper around `simple-markdown`.
+
+Contains markdown related functions in pure javascript, extracted from perseus-markdown.jsx.
+
+Note that this file may be used in stand alone nodejs, thus do not import anything from Perseus.

packages/simple-markdown/README.md

@@ -1,11 +1,9 @@
-simple-markdown
-===============
+# @khanacademy/simple-markdown
 
 simple-markdown is a markdown-like parser designed for simplicity
 and extensibility.
 
-Philosophy
-----------
+## Philosophy
 
 Most markdown-like parsers aim for [speed][marked] or
 [edge case handling][CommonMark].
@@ -31,15 +29,14 @@ simple-markdown is [MIT licensed][LICENSE].
 
 [LICENSE]: https://github.com/Khan/perseus/blob/master/LICENSE
 
-Getting started
----------------
+## Getting started
 
 First, let's parse and output some generic markdown using
 simple-markdown.
 
 If you want to run these examples in
-node, you should run `npm install` in the simple-markdown
-folder or `npm install simple-markdown` in your project's
+node, you should run `yarn` in the simple-markdown
+folder or `yarn add simple-markdown` in your project's
 folder. Then you can acquire the `SimpleMarkdown` variable
 with:
 
@@ -107,8 +104,7 @@ call `mdOutput`:
 ```
 
 
-Adding a simple extension
--------------------------
+## Adding a simple extension
 
 Let's add an underline extension! To do this, we'll need to create
 a new rule and then make a new parser/outputter. The next section
@@ -223,8 +219,7 @@ markdown with underlines!
 ```
 
 
-Basic parsing/output API
-------------------------
+## Basic parsing/output API
 
 #### `SimpleMarkdown.defaultBlockParse(source)`
 
@@ -250,8 +245,7 @@ Returns React-renderable output for `syntaxTree`.
 *Note: raw html output will be coming soon*
 
 
-Extension Overview
-------------------
+## Extension Overview
 
 Elements in simple-markdown are generally created from rules.
 For parsing, rules must specify `match` and `parse` methods.
@@ -367,8 +361,7 @@ The simple-markdown API contains several helper methods for
 creating rules, as well as methods for creating parsers and
 outputters from rules.
 
-Extension API
--------------
+## Extension API
 
 simple-markdown includes access to the default list of rules,
 as well as several functions to allow you to create parsers and
@@ -443,11 +436,5 @@ var blockParseAndOutput = function(source) {
 };
 ```
 
-Extension rules helper functions
---------------------------------
-
-*Coming soon*
-
-LICENSE
--------
+## LICENSE
 MIT. See the LICENSE file for text.