polyfact - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

examples/counter.ts

@@ -1,11 +0,6 @@
-import { generateWithType } from "../index";
+import { generateWithType } from "../lib/index";
 import * as t from "io-ts";
 
 (async () => {
-    console.log(
-        await generateWithType(
-            "Count from 1 to 5",
-            t.type({ aa: t.array(t.type({ a: t.number })) }),
-        ),
-    );
+    console.log(await generateWithType("Count from 1 to 5", t.type({ result: t.array(t.number) })));
 })();

package.json

 {
     "name": "polyfact",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "main": "dist/index.js",
@@ -5,0 +5,0 @@ "types": "dist/index.d.ts",

README.md

@@ -1,30 +0,46 @@
-# polyfact-node
+# Polyfact
 
-`polyfact-node` is a CLI nodejs package aimed at assisting developers in creating project using AI. This bundle of dev-tools is currently under active development, with documentation autogeneration as its functional feature at this stage.
+`polyfact` is a nodejs package aimed at assisting developers in creating project using AI.
+The package is split into 2 parts:
+  -  The [**SDK**](#sdk) that can be imported in any nodejs project and provides the basic building blocks for AI tool developement
+  -  The [**CLI**](#cli) which is a bundle of dev-tools currently under active development, with documentation autogeneration as its functional feature at this stage.
 
-## Installation
+## SDK
 
-To install polyfact-node, you'll need Node.js installed on your computer. 
+### Installation
 
-To install globally:
+To install polyfact into your repository:
 ```bash
-yarn global add polyfact
+npm install polyfact
 ```
-or
+
+Get your your polyfact token by signing up with github here: https://app.polyfact.com
+Add your Polyfact Token in the `POLYFACT_TOKEN` environment variable:
 ```bash
-npm install -g polyfact
+export POLYFACT_TOKEN= # The token displayed on https://app.polyfact.com
 ```
 
-You can verify the installation with the following command:
+### Usage
 
+You can now use Polyfact in your nodejs project:
+```js
+import { generateWithType } from "polyfact";
+import * as t from "io-ts";
+
+(async () => {
+    const result = await generateWithType("Count from 1 to 5", t.type({ result: t.array(t.number) }));
+
+    console.log(result);
+})();
+```
 ```bash
-polyfact --version
+{ result: [1, 2, 3, 4, 5] }
 ```
 
-## Command
+## CLI
 
-`polyfact-node` uses the following command structure for documentation generation:
+`polyfact` uses the following command structure for documentation generation:
 
 ```bash
-polyfact docs <folder> [options]
+npx polyfact docs <folder> [options]
 ```
@@ -48,9 +64,9 @@
 # Generate documentation from the src folder with the default parameters
-polyfact docs ./src 
+npx polyfact docs ./src 
 
 # Generate documentation with a specific name from the src folder and output to a specific folder
-polyfact docs ./src --name "my-documentation"
+npx polyfact docs ./src --name "my-documentation"
 
 # Generate documentation and deploy it to a specific subdomain
-polyfact docs ./src --deploy my-subdomain
+npx polyfact docs ./src --deploy my-subdomain
 ```
@@ -60,2 +76,2 @@
 
-`polyfact-node` is planned to support more dev-tools features in the near future. Stay tuned for more enhancements that would aid you with AI features.
+`polyfact` is planned to support more dev-tools features in the near future. Stay tuned for more enhancements that would aid you with AI features.

No alert changes

Improved metrics

Total package byte prevSize

810147

increased by0.06%

Number of lines in readme file

76

increased by26.67%

Worsened metrics

Lines of code

740

decreased by-0.67%

No dependency changes