fix: add description to package and simplify readme (#26)

NPM was displaying the html in the markup, but the HTML doesn't align with the template-library, so I used the template from that repo. I also fixed an issue with the table and added a description to the package.json for NPM to use.
reside-eng · Jan 18, 2022 · 170c34b · 170c34b
1 parent 4d68cb3
commit 170c34b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,6 @@
-<div align="center">
-    <h1>@side/fortifyjs</h1>
-    <div>A platform-agnostic lib for generating security headers for your web application.</div>
-    </br>
-</div>
+# @side/fortifyjs
 
-<div align="center">
+A platform-agnostic library for generating security headers for your web application.
 
 [![NPM version][npm-image]][npm-url]
 [![License][license-image]][license-url]
@@ -171,7 +167,6 @@ Since this library is specifically for delivering the relevant headers to secure
 | X-Download-Options                | noopen                                                                                                                                                                                                                                            | [Link][x-download-options-url]                |
 | X-Frame-Options                   | SAMEORIGIN                                                                                                                                                                                                                                        | [Link][x-frame-options-url]                   |
 | X-Permitted-Cross-Domain-Policies | none                                                                                                                                                                                                                                              | [Link][x-permitted-cross-domain-policies-url] |
-| ---------------------------       |
 
 ### Contributing Policy
 

diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "main": "dist/index.js",
   "repository": "https://github.com/reside-eng/fortifyjs.git",
+  "description": "A platform-agnostic library for generating security headers for your web application.",
   "author": "Side Platform Engineering",
   "license": "MIT",
   "types": "dist/index.d.ts",