Skip to content

Commit fa26ce7

Browse files
committed
Update README.md
1 parent 60c4c10 commit fa26ce7

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@ A web component to be able to use typescript in simple web pages.
44
After seeing the announcement for [--eraseableSyntaxOnly in typescript 5.8](https://devblogs.microsoft.com/typescript/announcing-typescript-5-8/#the---erasablesyntaxonly-option) it gave me the idea that maybe node should not be the only one capable of such feats.
55

66
**Current features:**
7-
- [x] remove `//` comments
8-
- [x] remove some types after `:`
9-
- [ ] remove type casts
10-
- [ ] ... and everything else related to erasing syntax
7+
- [x] uses [ts-blank-space](https://github.com/bloomberg/ts-blank-space) to replace types with whitespace
118
- [ ] pass attributes to the underlying script tag
9+
- [ ] figure out distribution + licensing
10+
- [ ] reduce bundle size
1211

1312
## Usage
14-
Load the web component to your file and use `<script-ts>` just like you would the regular `<script>` tag.
13+
Load the web component and use `<script-ts>` just like you would the regular `<script>` tag.
1514

1615
```html
17-
<script src="https://cdn.jsdelivr.net/gh/petii/script-ts@master/script-ts.js"></script>
16+
<script src="https://cdn.jsdelivr.net/gh/petii/script-ts/script-ts.min.js"></script>
17+
...
18+
<script-ts>
19+
// there's no real support (yet) for inlined scripts unfortunately but _technically_ it works
20+
</script-ts>
21+
<!-- loading files however should help with development -->
22+
<script-ts src="you-script.ts"></script-ts>
1823
```
1924

2025
## Development
21-
Unfortunately it's not as easy as loading up the file but serving it locally should work:
22-
23-
```shell
24-
npx serve --cors
25-
```
26+
~~Unfortunately it's not as easy as loading up the file but serving it locally should work: `npx serve --cors`~~

0 commit comments

Comments
 (0)