Skip to content

Commit

Permalink
fix: Docs updates (#21)
Browse files Browse the repository at this point in the history
* chore: update badges

* chore: add CHANGELOG

* chore: add changelog generation

* chore: add LTS Node to travis builds

* chore: upgrade some packages

* fix: linter errors

* chore(package.json): add homepage

* chore: only test against LTS (getting rate limits from Browserstack)

* chore: use .browserlistrc

* chore: downgrade enzyme
  • Loading branch information
petermikitsh committed Sep 3, 2019
1 parent acbb5b4 commit c1439d6
Show file tree
Hide file tree
Showing 10 changed files with 6,050 additions and 2,556 deletions.
8 changes: 8 additions & 0 deletions . browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
last 4 versions
Android >= 4.4
Chrome >= 49
Edge >= 12
Firefox >= 51
IE >= 11
iOS >= 8.4
Safari >= 8
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
language: node_js
node_js:
- "8"
- "stable"
before_script:
- npm run lint
- npm run build
Expand Down
82 changes: 82 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
## v2.0.5

- [Tabs] Implementation detail changes to reduce bundle size

## v2.0.4

- [Switch] [TextField] enhancements to support Preact

## v2.0.3

- [Dialog] fix for better support for Preact

## v2.0.2

- Upgrade to @babel/runtime@7.0.0

## v2.0.1

- Exclude require statements to CSS files in CommonJS build

## v2.0.0

### API Changes

- `Switch` and `TextField` no longer autogenerate an aria-labelledby attribute for their input fields. They can be supplied via the labelId prop. This change was needed to fix server-side rendering hydration errors on the client. uuid was also removed from dependencies, so expect a slightly smaller bundle size.

### Build Changes

For versions `1.2.3` (inclusive) and prior, the distributions were incorrect.

- The commonjs `dist/index.js` file had module ES module import/export syntax.
- The commonjs source files had their css inlined (poor for performance and causes bundle size bloat).
- The module build couldn't be tree-shaken since `{sideEffects: false}` was not set in package.json.
- Both builds missed other opportunities for reducing bundle size, like removing prop types.

## v1.2.3

- remove `deep-assign` from dependencies
- remove `keycode` from dependencies

## v1.2.2

No changes.

## v1.2.1

- Upgrade from babel 6 to 7
- switch linter from eslint to xo
- upgrade to webpack 4
- move babel dependencies to devDependencies (where applicable)

## v1.2.0

- `SelectField` component implementation

## v1.1.0

- Added `Table`, partial implementation (https://material.io/guidelines/components/data-tables.html)
- Upgraded some dependencies

## 1.0.0

🎉 1.0.0 release 🎉

- **Support for React 16.** Cleaned up warnings that were present upon upgrade.
- **Removed undocumented API's.** Some components accepted an undocumented domRef property; these have been removed. Out of an abundance of caution, a major release bump-- upgrading should be relatively effortless, however).

## 0.0.5

- [SnackBar] fix centering on IE 11 and Safari

## 0.0.4

- [GridItem] fix issue where child DOM elements could overflow outside the grid

## 0.0.3

- [Tabs] a11y enhancements, fix UI bug where tabs had incorrect height

## v0.0.2-0

## v0.0.1-0
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
material-react-components
=========================

[![Build Status](https://travis-ci.org/collegepulse/material-react-components.svg?branch=master)](https://travis-ci.org/collegepulse/material-react-components/)
[![Coverage Status](https://coveralls.io/repos/github/collegepulse/material-react-components/badge.svg?branch=master)](https://coveralls.io/github/collegepulse/material-react-components?branch=master)
[![Dependency Status](https://david-dm.org/collegepulse/material-react-components.svg)](https://david-dm.org/collegepulse/material-react-components)
[![npm package][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Dependencies Status][david-image]][david-url]

This is a collection of React components that implement Google's [material design specification](https://material.io/guidelines). The goals of this project include:

Expand All @@ -26,3 +27,12 @@ Acknowlegements
[BrowserStack](https://www.browserstack.com/) has provided us with the tools and infrastructure necessary to build a high quality component library by testing our components on an array of browsers. Thank you.

[material-ui](https://github.com/callemall/material-ui) has been an influence in some of our component implementations. We are appreciative of the effort and contributions happening over there.

[npm-image]:https://img.shields.io/npm/v/material-react-components.svg
[npm-url]:https://www.npmjs.com/package/material-react-components
[travis-image]:https://travis-ci.org/collegepulse/material-react-components.svg?branch=master
[travis-url]:https://travis-ci.org/collegepulse/material-react-components
[coveralls-image]:https://coveralls.io/repos/github/collegepulse/material-react-components/badge.svg?branch=master
[coveralls-url]:https://coveralls.io/github/collegepulse/material-react-components?branch=master
[david-image]:https://david-dm.org/collegepulse/material-react-components/status.svg
[david-url]:https://david-dm.org/collegepulse/material-react-components
Loading

0 comments on commit c1439d6

Please sign in to comment.