Skip to content

Commit

Permalink
docs(general): update README and LICENSE
Browse files Browse the repository at this point in the history
Update README format, correct Table of Contents, and add License information
Add LICENSE file
  • Loading branch information
bbender committed May 16, 2017
1 parent 3eea9ab commit 8cfcd15
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 11 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Cisco Systems, Inc.

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.
32 changes: 21 additions & 11 deletions README.md
@@ -1,17 +1,22 @@
# Cisco Spark for React _(react-ciscospark)_
# react-ciscospark

* THIS REPO CONTAINS EXPERIMENTAL CODE *
[![CircleCI](https://img.shields.io/circleci/project/github/ciscospark/react-ciscospark/master.svg)](https://circleci.com/gh/ciscospark/react-ciscospark)
[![license](https://img.shields.io/github/license/ciscospark/react-ciscospark.svg)](https://github.com/ciscospark/react-ciscospark/blob/master/LICENSE)

> The Cisco Spark for React library allows developers to easily incorporate Spark functionality into an application.
> Cisco Spark for React
** THIS REPO CONTAINS EXPERIMENTAL CODE **

The Cisco Spark for React library allows developers to easily incorporate Spark functionality into an application.

## Table of Contents
- [Background](#background)
- [Widgets](#widgets)
- [Install](#install)
- [Build from Source](#build-from-source)
- [Components](#components)
- [Install](#install)
- [Browser Support](#browser-support)
- [Limitations](#limitations)
- [Development](#development)
- [License](#license)

## Background

Expand All @@ -32,14 +37,19 @@ While many of our components are purely presentational, some have extended funct
1. Clone this repo using a git client (e.g. `git clone https://github.com/ciscospark/react-ciscospark.git`)
1. Run `npm install` from the root of the repo. You will want to run this every time you pull down any new updates.
1. From the root of the repo, run the following to build the widget:

```sh
npm run build
```
```sh
npm run build
```
1. The built bundles are located at `packages/node_modules/@ciscospark/PACKAGE_NAME/dist`.


## Limitations

### Development

* `stylelint` currently ignores all `node_modules` directories, and will not lint our packages. Discussion: <https://github.com/stylelint/stylelint/issues/2236>

## License

&copy; 2017 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.

See [LICENSE](LICENSE) for details.

0 comments on commit 8cfcd15

Please sign in to comment.