Skip to content

Commit 93c6bec

Browse files
Bring back the README for @glimmer/component (#20946)
1 parent bd34421 commit 93c6bec

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

packages/@glimmer/component/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# @glimmer/component
2+
3+
[![npm version](https://badge.fury.io/js/%40glimmer%2Fcomponent.svg)](https://badge.fury.io/js/%40glimmer%2Fcomponent)
4+
[![CI](https://github.com/emberjs/ember.js/workflows/CI/badge.svg)](https://github.com/emberjs/ember.js/actions?query=workflow%3ACI)
5+
6+
## Installation
7+
8+
Add this package to your project:
9+
10+
```bash
11+
npm install --save-dev @glimmer/component
12+
```
13+
14+
## Usage
15+
16+
To use this in a Glimmer application, import the package and export an extended class:
17+
18+
```glimmer-ts
19+
import Component from '@glimmer/component';
20+
21+
export default class MyComponent extends Component {
22+
get doubled() {
23+
return this.args.foo * 2;
24+
}
25+
26+
<template>
27+
{{@foo}} * 2 === {{this.doubled}}
28+
</template>
29+
}
30+
```
31+
32+
## Contributing
33+
34+
Bug reports and pull requests are welcome on GitHub at https://github.com/emberjs/ember.js
35+
36+
## License
37+
38+
MIT License.

0 commit comments

Comments
 (0)