Write a basic README (#111)

Author: rogermparent

README.md

@@ -1,74 +1,78 @@
-<p align="center">
-  <a href="https://www.gatsbyjs.com">
-    <img alt="Gatsby" src="https://www.gatsbyjs.com/Gatsby-Monogram.svg" width="60" />
-  </a>
-</p>
-<h1 align="center">
-  Starter for creating a Gatsby Theme workspace
-</h1>
-
-```shell
-gatsby new my-theme https://github.com/gatsbyjs/gatsby-starter-theme-workspace
-cd my-theme
-yarn workspace example develop
-```
+# Gatsby Theme: Iterative
 
-## Layout
-
-```text
-.
-├── README.md
-├── gatsby-theme-minimal
-│   ├── README.md
-│   ├── gatsby-config.js
-│   ├── index.js
-│   └── package.json
-├── example
-│   ├── README.md
-│   ├── gatsby-config.js
-│   ├── package.json
-│   └── src
-├── package.json
-└── yarn.lock
-
-3 directories, 10 files
-```
+This Gatsby Theme houses the shared website code for all websites for
+[Iterative](https://iterative.ai). This package is currently purpose-built
+specifically for our websites and not very useful outside of them, but we intend
+to change that as we make improvements and iron out issues!
 
-### `gatsby-theme-minimal`
+## Usage
 
-This directory is the theme package itself. You should rename this at some point
-to be `gatsby-theme-{my-theme-name}`. Also change the `package.json` name field
-and the corresponding dependency in the example directory's
-`package.json`/`gatsby-config.js` to match the chosen name.
+### Options
 
-- `gatsby-theme-minimal/`
-  - `gatsby-config.js`: An empty gatsby-config that you can use as a starting
-    point for building functionality into your theme.
-  - `index.js`: Since themes also function as plugins, this is an empty file
-    that gatsby needs to use this theme as a plugin.
-  - `package.json`: The dependencies that your theme will pull in when people
-    install it. `gatsby` should be a `peerDependency`.
+- disable: boolean Default: Boolean(process.env.SKIP_DOCS)
 
-### `example`
+- getTemplate: function Default: () => defaultGetTemplate
 
-This is an example usage of your theme. It should look the same as the site of
-someone who installed and used your theme from npm.
+- defaultTemplate: string Default: require.resolve('./src/templates/doc.tsx')
 
-- `example/`
-  - `gatsby-config.js`: Specifies which theme to use and any other one-off
-    config a site might need.
-  - `src/`: Source code such as one-off pages or components that might live in a
-    user's site.
+- remark: boolean Default: true
 
-You can run the example with:
+- filesystem: boolean Default: true
 
-```shell
-yarn workspace example develop
-```
+- glossaryDirectory: string Default: 'docs/user-guide/basic-concepts'
+
+- simpleLinkerTerms: { matches: string, url: string }[] These terms will be
+  passed to the simpleLinker remark plugin
+
+- cssBase: string Used as base files for global PostCSS variables and queries
+
+- customMediaConfig: object config passed to `postcss-custom-media`
 
-## 🚀 Quick start (Gatsby Cloud)
+- customPropertiesConfig: object config passed to `postcss-custom-properties`
 
-Deploy this starter with one click on
-[Gatsby Cloud](https://www.gatsbyjs.com/cloud/):
+- colorModConfig: object config passed to `postcss-color-mod`
 
-[<img src="https://www.gatsbyjs.com/deploynow.svg" alt="Deploy to Gatsby Cloud">](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/gatsbyjs/gatsby-starter-theme-workspace)
+- postCssPlugins: Plugin[] If specified, this array will completely replace
+  plugins this theme passes to PostCSS. This is mostly an escape hatch for if
+  styles are broken with the default plugins. Check out
+  [the theme's `gatsby-config`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/gatsby-theme-iterative/gatsby-config.js)
+  to see the default plugins, as not having them in this option will very likely
+  break core functionality.
+
+### Examples
+
+See this example from
+[the example website's `gatsby-config.js`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/example/gatsby-config.js).
+
+```js
+const path = require('path')
+const {
+  name: themePackageName
+} = require('../gatsby-theme-iterative/package.json')
+
+module.exports = {
+  trailingSlash: 'never',
+  siteMetadata: {
+    title: 'Example website',
+    description: 'Example website description',
+    keywords: ['docs', 'test'],
+    siteUrl: 'http://localhost:8000'
+  },
+  plugins: [
+    {
+      resolve: themePackageName,
+      options: {
+        simpleLinkerTerms: require('./content/linked-terms')
+      }
+    },
+    {
+      resolve: 'gatsby-source-filesystem',
+      options: {
+        name: 'images',
+        path: path.join(__dirname, 'static', 'img')
+      }
+    },
+    '@sentry/gatsby'
+  ]
+}
+```