Merge branch 'main' of https://github.com/CGWebDev2003/javascript-api

Colin Grahm · Colin Grahm · commit cb56a3334565 · 2023-05-20T02:26:45.000+02:00
diff --git a/README.md b/README.md
@@ -1,3 +1,53 @@
-# Vanilla JavaScript API
+# Welcome to Neptune JS!
 
-The official JavaScript API for Neptune CSS 
+![](https://img.shields.io/github/v/tag/neptune-css/neptune-css?color=%2300AACC) ![](https://img.shields.io/npm/dm/@neptune-css/neptune?color=%2300AACC) ![](https://img.shields.io/npm/l/@neptune-css/neptune?color=%2300AACC) 
+***
+
+![readme_banner_js](https://github.com/neptune-css/javascript-api/assets/122671813/42fd3da4-3f6e-42de-b68b-487e5fc7da47)
+
+
+## Install
+
+### NMP
+Copy the following Code to install the [npm package](https://www.npmjs.com/package/@neptune-css/neptune).
+```
+npm i @neptune-css/neptune
+```
+
+### CDN
+Use the following tag to import neptune via cdn. Replace [VERSION] with the version you want (`vx.x.x`).
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@neptune-css/neptune@[VERSION]/neptune.css">
+```
+
+#### Example
+```html
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+        <!-- Import neptune ui -->
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@neptune-css/neptune@[VERSION]/neptune.css">
+        
+        <title>Neptune example</title>
+    </head>
+    <body>
+        <!-- Your Content -->
+    </body>
+</html>
+```
+
+## Documentation
+You can read the docs [here](http://docs.neptunecss.org).
+
+## Snippets Extension
+Download it in [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=NeptuneCSS.neptune-snippets) or checkout on [GitHub](https://github.com/neptune-css/neptune-snippets).
+
+## License
+[MIT LICENSE](https://github.com/neptune-css/neptune-css/blob/main/LICENSE)
+
+## Author
+[Colin Grahm](https://github.com/CGWebDev2003)
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "@neptune-css/javascript-api",
+    "name": "@neptune-css/neptune-js",
     "version": "0.1.0",
     "description": "The official vanilla javascript api for Neptune CSS",
     "main": "index.js",

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@neptune-css/javascript-api",`
	`2`	`+ "name": "@neptune-css/neptune-js",`
`3`	`3`	`"version": "0.1.0",`
`4`	`4`	`"description": "The official vanilla javascript api for Neptune CSS",`
`5`	`5`	`"main": "index.js",`