From 2af2218d6dc74e8cf07a2a7eddd8c309e04cd4c5 Mon Sep 17 00:00:00 2001 From: Jonah Henriksson <33059163+JonahPlusPlus@users.noreply.github.com> Date: Wed, 13 Nov 2024 17:05:51 -0500 Subject: [PATCH] Fix package and add badges --- README.md | 10 +++++++++- package.json | 6 +++++- tsconfig.json | 2 +- 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 65b0fe1..382a751 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,11 @@

-# 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/). @@ -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). diff --git a/package.json b/package.json index e479045..c2d09a2 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -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", diff --git a/tsconfig.json b/tsconfig.json index aa56406..1ceea51 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -16,5 +16,5 @@ "jsxImportSource": "solid-js", "types": ["vitest/globals", "@testing-library/jest-dom"] }, - "exclude": ["node_modules"] + "exclude": ["node_modules", "dist"] }