@eeue56/geiriadur - npm Package Compare versions

Comparing version 0.0.1-beta.0 to 0.0.1

package.json

 {
   "name": "@eeue56/geiriadur",
-  "version": "0.0.1-beta.0",
+  "version": "0.0.1",
   "description": "An Elm-like documentation generator for TypeScript",
@@ -9,3 +9,5 @@ "main": "src/geiriadur.ts",
   },
-  "bin": "build/geiriadur.js",
+  "bin": {
+    "geiriadur": "build/geiriadur.js"
+  },
   "repository": {
@@ -12,0 +14,0 @@ "type": "git",

README.md

 # geiriadur
-An Elm-style documentation generator for typescript
+An Elm-style documentation generator for TypeScript. It uses a markdown file to document exposed types and functions, along with their type signature and any jsdoc they may have. There is also a link to the source included.
+
+Part of the [Hiraeth](https://github.com/eeue56/hiraeth) collection.
+
+## Example
+
+```javascript
+export function program<Model, Msg>(program: Program<Model, Msg>) {
+}
+```
+
+will generate [this](https://github.com/eeue56/coed/blob/main/docs/src/html.md#program)
+
+## Installation
+
+```
+npm install --save @eeue56/geiriadur
+```
+
+## Usage
+
+```
+npx @eeue56/geiriadur
+```
+
+will find docs within the current tsconfig.json and generate them in a docs folder. Check out an example [here](https://github.com/eeue56/coed#usage)
+
+
+## Name
+
+Geiriadur means dictionary. An English speaker may pronounce it as "gay-rh-ya-dirh".

No alert changes

Improved metrics

Total package byte prevSize

23117

increased by3.58%

Number of lines in readme file

32

increased by966.67%

No dependency changes