Skip to content

Commit cd010eb

Browse files
committed
docs(Forma): Updated Readme and added license
1 parent 6e49696 commit cd010eb

File tree

2 files changed

+33
-4
lines changed

2 files changed

+33
-4
lines changed

LICENSE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) 2018-present Contentful GmbH
2+
3+
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:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
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.

README.md

+26-4
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,33 @@
33
# Forma 36 Design System by Contentful
44

55
![build status](https://travis-ci.com/contentful/forma-36.svg?token=9ZgfZHVDFAy8E7oFpbGM&branch=master)
6-
76
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
87

9-
This is the monorepo for the Forma 36 design system by Contentful. It is structured into the following packages:
8+
This is the monorepo for the Forma 36 design system by Contentful.
9+
10+
<!-- TOC -->
11+
12+
- [Packages](#packages)
13+
- [Forma 36 Website (WIP)](#forma-36-website)
14+
- [Website Readme](./packages/forma-36-website/README.md)
15+
- [Forma 36 React Components](#forma-36-react-components)
16+
- [React Component Library Readme](./packages/forma-36-react-components/README.md)
17+
- [Adding packages](#adding-packages)
18+
- [Releasing a new version](#releasing-a-new-forma-36-version)
19+
- [Contribution Guidelines](#contribution-guidelines)
20+
<!-- /TOC -->
21+
22+
# Packages
23+
24+
Forma 36 is currently structured into the following packages:
1025

1126
```
1227
packages/
1328
Forma 36 Website
1429
Forma 36 React Components
1530
```
1631

17-
## Forma 36 Website
32+
## Forma 36 Website (WIP)
1833

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

2843
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}
2944

30-
## Releasing a new Forma 36 version
45+
# Releasing a new Forma 36 version
3146

3247
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
3348

3449
_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._
50+
51+
# Contribution Guidelines
52+
53+
Every package contains a readme file covering contribution guidelines and best practices.
54+
55+
- [Website Readme](./packages/forma-36-website/README.md)
56+
- [React Component Library Readme](./packages/forma-36-react-components/README.md)

0 commit comments

Comments
 (0)