Skip to content

Commit

Permalink
Fix package and add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
JonahPlusPlus committed Nov 13, 2024
1 parent c7085a3 commit 2af2218
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
</picture>
</p>

# Solid Effect
# solid-effect

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

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

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

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

## Documentation

[Read the docs to see all the features + examples!](https://jonahplusplus.dev/solid-effect/)

## Any examples of use-cases for using Effect with SolidJS?

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).
Expand Down
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "solid-effect",
"version": "1.0.0-beta.1",
"version": "1.0.0-beta.2",
"description": "A collection of utilities for working with EffectTS in SolidJS",
"type": "module",
"scripts": {
Expand Down Expand Up @@ -58,6 +58,10 @@
"effect": "^3.8.4",
"solid-js": "^1.9.3"
},
"files": [
"dist",
"LICENCE-*"
],
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@
"jsxImportSource": "solid-js",
"types": ["vitest/globals", "@testing-library/jest-dom"]
},
"exclude": ["node_modules"]
"exclude": ["node_modules", "dist"]
}

0 comments on commit 2af2218

Please sign in to comment.