Update README.md

packages/effect-utils/README.md

@@ -1 +1,15 @@
 # effect-utils
+
+A utility for working with Effect. This package is intended for internal use only.
+
+## API
+
+### `executeEffect(effect, runtime?)`
+
+Execute the given Effect using `runPromiseExit`. It returns the value when result is `Exit.Success<A>`. and it throws the value if result is failure.
+
+And it resolve `Option<A>` value into `A | null`.
+
+## License
+
+MIT

packages/effect-utils/package.json

@@ -1,17 +1,13 @@
 {
   "name": "effect-utils",
   "version": "0.0.1",
-  "description": "A utility library for working with Effect",
+  "description": "A utility for working with Effect",
   "type": "module",
   "publishConfig": {
     "access": "public",
     "registiry": "https://registry.npmjs.org"
   },
-  "files": [
-    "package.json",
-    "README.md",
-    "dist"
-  ],
+  "files": ["package.json", "README.md", "dist"],
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -27,9 +23,7 @@
     "prepack": "yarn build",
     "publish": "yarn npm publish"
   },
-  "keywords": [
-    "effect"
-  ],
+  "keywords": ["effect"],
   "author": {
     "name": "Chanhee Lee",
     "email": "[email protected]"

packages/graphql-effect/README.md

@@ -1 +1,28 @@
-# envelop-execute-effect
+# graphql-effect
+
+Make your GraphQL Schema to allow use Effect.
+
+## Install
+
+```
+$ yarn add graphql-effect
+```
+
+## Usage
+
+```ts
+import { enableExecuteEffect } from "graphql-effect";
+
+declare const yourSchema: import("graphql").GraphQLSchema;
+const schema = enableExecuteEffect(yourSchema);
+```
+
+## API
+
+### `enableExecuteEffect(schema, runtime?)`
+
+Converts the given `GraphQLSchema`. The `Effect.Effect` will be available as a result of the field resolver.
+
+## License
+
+MIT