Skip to content

Commit

Permalink
chore: add release script (#62)
Browse files Browse the repository at this point in the history
* chore: fix children type

* chore: install changeset

* chore: add publish script

* chore: update README

* chore: add README for react-vfx package

* chore: add test command

* chore: suppress lint errors

* chore: suppress lint warnings

* chore: rename command for release
  • Loading branch information
fand authored Jun 13, 2024
1 parent ba5cd8d commit 170c41f
Show file tree
Hide file tree
Showing 10 changed files with 2,127 additions and 174 deletions.
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,19 @@
## Install

```
npm i -S react-vfx
npm i react-vfx
```

## Usage

REACT-VFX exports `VFXSpan`, `VFXImg` and `VFXVideo`.
These components works just like `<span>`, `<img>` and `<video>` - accepts all properties they have, but they are rendered in WebGL world with shader effects!
REACT-VFX exports `VFXImg`, `VFXVideo`, `VFXSpan` and `VFXDiv`.
These components works just like `<img>`, `<video>`, `<span>` and `<div>` - accepts all properties they have, but they are rendered in WebGL world with shader effects!

```ts
import * as VFX from 'react-vfx';

export default () => (
<VFX.VFXProvider>
{/* Render text as image, then apply the shader effect! */}
<VFX.VFXSpan shader="rainbow">Hi there!</VFX.VFXSpan>

{/* Render image with shader */}
<VFX.VFXImg src="cat.png" alt="image" shader="rgbShift"/>

Expand All @@ -34,6 +31,14 @@ export default () => (
<VFX.VFXVideo src="mind_blown.mp4"
autoplay playsinline loop muted
shader="halftone"/>

{/* Render text as image, then apply the shader effect! */}
<VFX.VFXSpan shader="rainbow">Hi there!</VFX.VFXSpan>

{/* Or even inputs! */}
<VFX.VFXDiv shader="rainbow">
<input type="text" value="hello" />
</VFX.VFXDiv>
</VFX.VFXProvider>
);
```
Expand Down
Loading

0 comments on commit 170c41f

Please sign in to comment.