@ng-doc/core - npm Package Compare versions

Comparing version 15.0.0-beta.16 to 15.0.0-beta.17

package.json

 {
   "name": "@ng-doc/core",
-  "version": "15.0.0-beta.16",
+  "version": "15.0.0-beta.17",
   "type": "commonjs",
@@ -12,3 +12,23 @@ "peerDependencies": {
   "main": "./index.js",
-  "types": "./index.d.ts"
+  "types": "./index.d.ts",
+  "keywords": [
+    "angular",
+    "documentation",
+    "generator",
+    "builder",
+    "guides",
+    "api",
+    "demo",
+    "ng-doc"
+  ],
+  "author": "Skoropad Aleksandr <[e-mail]>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skoropadas/ng-doc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/skoropadas/ng-doc/issues"
+  },
+  "homepage": "https://ng-doc.com/",
+  "license": "MIT"
 }

README.md

@@ -1,11 +0,40 @@
-# core
+[![GitHub Workflow Status][build-shield]][build-url]
+[![NPM][npm-shield]][npm-url]
+[![MIT License][license-shield]][license-url]
 
-This library was generated with [Nx](https://nx.dev).
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/skoropadas/ng-doc">
+    <img src="apps/ng-doc/src/assets/images/ng-doc.svg" alt="Logo" height="100px">
+  </a>
 
-## Building
+<h3 align="center">NgDoc</h3>
 
-Run `nx build core` to build the library.
+  <p align="center">
+    Create documentation faster than ever!
+    <br />
+    <a href="https://ng-doc.com/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+	<a href="https://ng-doc.com/getting-started/roadmap">Roadmap</a>
+    ·
+    <a href="https://github.com/skoropadas/ng-doc/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/skoropadas/ng-doc/issues">Request Feature</a>
+  </p>
+</div>
 
-## Running unit tests
+<!-- ABOUT THE PROJECT -->
 
-Run `nx test core` to execute the unit tests via [Jest](https://jestjs.io).
+## About The Project
+
+This library is a part of NgDoc project, that uses to create documentation
+for Angular projects, please check our [repo](https://github.com/skoropadas/ng-doc) for more details.
+
+[npm-shield]: https://img.shields.io/npm/v/@ng-doc/builder.svg?style=for-the-badge
+[npm-url]: https://www.npmjs.com/package/@ng-doc/builder
+[license-shield]: https://img.shields.io/github/license/skoropadas/ng-doc.svg?style=for-the-badge
+[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
+[build-shield]: https://img.shields.io/github/actions/workflow/status/skoropadas/ng-doc/release.yml?style=for-the-badge&branch=release
+[build-url]: https://github.com/skoropadas/ng-doc/actions

Fixed alerts

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30964

increased by5.9%

Number of low license alerts

0

decreased by-100%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

41

increased by241.67%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes