Skip to content

Commit 2af2218

Browse files
committed
Fix package and add badges
1 parent c7085a3 commit 2af2218

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
</picture>
66
</p>
77

8-
# Solid Effect
8+
# solid-effect
9+
10+
[![NPM Version](https://img.shields.io/npm/v/solid-effect)](https://www.npmjs.com/package/solid-effect)
11+
[!![Documentation](https://img.shields.io/badge/documentation-FF4785?logo=storybook&logoColor=white)](https://jonahplusplus.dev/solid-effect/)
12+
![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-green)
913

1014
solid-effect is a utility library for working with [effect-ts](https://effect.website/) in [solid-js](https://www.solidjs.com/).
1115

@@ -15,6 +19,10 @@ Effect comes out of the box with utilities for error handling, caching, retry, i
1519

1620
What solid-effect does is allow you to use these utilities closer to the edge of your SolidJS app.
1721

22+
## Documentation
23+
24+
[Read the docs to see all the features + examples!](https://jonahplusplus.dev/solid-effect/)
25+
1826
## Any examples of use-cases for using Effect with SolidJS?
1927

2028
So far, I've been using Effect in my SolidJS app for my GraphQL client (service layers allow for defining configuration and better error handling) and for i18n/l10n (e.g. caching formatters based on locale).

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "solid-effect",
3-
"version": "1.0.0-beta.1",
3+
"version": "1.0.0-beta.2",
44
"description": "A collection of utilities for working with EffectTS in SolidJS",
55
"type": "module",
66
"scripts": {
@@ -58,6 +58,10 @@
5858
"effect": "^3.8.4",
5959
"solid-js": "^1.9.3"
6060
},
61+
"files": [
62+
"dist",
63+
"LICENCE-*"
64+
],
6165
"main": "./dist/index.cjs",
6266
"module": "./dist/index.js",
6367
"types": "./dist/index.d.ts",

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@
1616
"jsxImportSource": "solid-js",
1717
"types": ["vitest/globals", "@testing-library/jest-dom"]
1818
},
19-
"exclude": ["node_modules"]
19+
"exclude": ["node_modules", "dist"]
2020
}

0 commit comments

Comments
 (0)