Skip to content

Commit dd1862b

Browse files
committed
docs: document upgrade from v0.18.1 to 1.0.0
1 parent bd8affd commit dd1862b

File tree

2 files changed

+474
-15
lines changed

2 files changed

+474
-15
lines changed

README.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,24 @@ It integrates [Material Components for the Web](https://github.com/material-comp
1111
<a href="https://github.com/src-zone/material/actions"><img align="right" src="https://buildstats.info/github/chart/src-zone/material?branch=master&showStats=false" width="231" height="71"/></a>
1212

1313
[![npm](https://img.shields.io/npm/v/@blox/material.svg)](https://www.npmjs.com/package/@blox/material)
14-
[![npm](https://img.shields.io/npm/v/@blox/material/beta.svg)](https://www.npmjs.com/package/@blox/material)
1514
[![License](https://img.shields.io/github/license/src-zone/material.svg)](LICENSE.txt)
16-
[![CircleCI](https://img.shields.io/circleci/project/github/src-zone/material.svg)](https://circleci.com/gh/src-zone/material/tree/master)
15+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/src-zone/material/build)](https://github.com/src-zone/material/actions?query=workflow%3A%22Build%2C+Test%2C+Preview%22)
1716
[![Codecov](https://img.shields.io/codecov/c/github/src-zone/material)](https://codecov.io/gh/src-zone/material)
1817
[![Documentation](https://img.shields.io/badge/demo-website-lightgrey.svg)](https://material.src.zone/)
19-
* [Documention, Demo & Examples (for the beta releases)](https://material.src.zone/)
20-
* [Documention, Demo & Examples (for v0.x)](https://v0.material.src.zone/material)
18+
* [Documention, Demo & Examples](https://material.src.zone/)
19+
* [Old Documention, Demo & Examples (for v0.x)](https://v0.material.src.zone/material)
2120
* [Changelog](https://github.com/src-zone/material/blob/master/bundle/CHANGELOG.md)
2221
* [News (via twitter)](https://twitter.com/TheSourceZone)
22+
* [Guide for upgrading from v0.18.1 to v1.0.0](docs/migration/migration-0-to-1.md)
2323

24-
## Status
24+
## Roadmap for 2.0.0
2525

26-
We're currently in the progress of upgrading to the latest version of material-components-web. This
27-
introduces a significant amount of breaking changes. Hence the status of the master branch is beta, and we're
28-
publishing beta releases from that branch.
29-
30-
The [stable_v0 branch](https://github.com/src-zone/material/tree/stable_v0) contains the branch for the latest
31-
non-beta builds.
32-
33-
The documentation site for the beta release is here: [https://material.src.zone](https://material.src.zone)
26+
* Upgrade to material-components-web 9.0.0
27+
* Implement new components: `banner`, `circular-progress`, `data-table`, `segmented-button`, `tooltip`,
28+
and `touch-target`
29+
* Add angular schematics support to help with installation
30+
* Add component alternatives to directives with complex structure
31+
* Add autocomplete input component
3432

3533
## Building from source
3634

@@ -45,8 +43,8 @@ some tips:
4543
you must have built the material `bundle` first.
4644
* Check the `package.json` files for other commands that can be used to build, debug, test,
4745
release, or publish the library.
48-
* Publishing a new bundle is handled by circleci. The commands for publishing/releasing a new
46+
* Publishing a new bundle is handled by Github Actions. The commands for publishing/releasing a new
4947
version are in the root `package.json`. These commands create the appropriate tags and changes
50-
that are picked up by the circleci build to do an actual publish/deploy/distribution of a new
48+
that are picked up by a Github Action build to do an actual publish/deploy/distribution of a new
5149
version of the library.
5250
* Please use commit messages according to the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines).

0 commit comments

Comments
 (0)