Skip to content

Commit

Permalink
docs(Forma): Updated Readme and added license
Browse files Browse the repository at this point in the history
  • Loading branch information
wichniowski committed Nov 21, 2018
1 parent 6e49696 commit cd010eb
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 4 deletions.
7 changes: 7 additions & 0 deletions LICENSE.md
@@ -0,0 +1,7 @@
Copyright (c) 2018-present Contentful GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 changes: 26 additions & 4 deletions README.md
Expand Up @@ -3,18 +3,33 @@
# Forma 36 Design System by Contentful

![build status](https://travis-ci.com/contentful/forma-36.svg?token=9ZgfZHVDFAy8E7oFpbGM&branch=master)

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)

This is the monorepo for the Forma 36 design system by Contentful. It is structured into the following packages:
This is the monorepo for the Forma 36 design system by Contentful.

<!-- TOC -->

- [Packages](#packages)
- [Forma 36 Website (WIP)](#forma-36-website)
- [Website Readme](./packages/forma-36-website/README.md)
- [Forma 36 React Components](#forma-36-react-components)
- [React Component Library Readme](./packages/forma-36-react-components/README.md)
- [Adding packages](#adding-packages)
- [Releasing a new version](#releasing-a-new-forma-36-version)
- [Contribution Guidelines](#contribution-guidelines)
<!-- /TOC -->

# Packages

Forma 36 is currently structured into the following packages:

```
packages/
Forma 36 Website
Forma 36 React Components
```

## Forma 36 Website
## Forma 36 Website (WIP)

This package includes the design system documentation which offers guidelines, best practices and examples.
See the README [here](./packages/forma-36-website/README.md)
Expand All @@ -27,8 +42,15 @@ A React component library built with Storybook. See the README [here](./packages

To add another package create a new directory in the packages folder. Make sure that the package name is prefixed with forma-36 (e.g. forma-36-css-utilities). Since we are using Lerna all package scripts are available from the root by running lerna run {script_name}

## Releasing a new Forma 36 version
# Releasing a new Forma 36 version

Commit your changes using yarn commit (semantic commit message). Lerna will keep track of which packages have changed. It is set up in independent mode so you're able to release independent versions of the packages. We use semantic release which will generate the next version number and release notes. Dispatch a new version by running yarn semantic-release

_NOTE: It is important that every new package includes semantic-release and semantic-release-monorepo in the dev-dependency list so that semantic release will work from the root of the monorepo._

# Contribution Guidelines

Every package contains a readme file covering contribution guidelines and best practices.

- [Website Readme](./packages/forma-36-website/README.md)
- [React Component Library Readme](./packages/forma-36-react-components/README.md)

0 comments on commit cd010eb

Please sign in to comment.