add CSS package readme

nasa-jpl · Oct 25, 2024 · 59f1b5f · 59f1b5f
1 parent 6162aeb
commit 59f1b5f
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/packages/css/README.md b/packages/css/README.md
@@ -0,0 +1,32 @@
+[![npm version](https://img.shields.io/npm/v/@nasa-jpl/stellar.svg)](https://www.npmjs.com/package/@nasa-jpl/stellar)
+
+# Stellar
+
+A CSS implementation of the Stellar design system for spacecraft operation tools.
+
+## Install
+
+```sh
+npm install @nasa-jpl/stellar --save
+```
+
+## Usage
+
+Import the desired CSS files into your project to make the classes globally available. See our [example project][stellar-example] for detailed API usage.
+
+```html
+<html>
+  <head>
+    <link href="@nasa-jpl/stellar/dist/css/button.css" rel="stylesheet" />
+  </head>
+  <body>
+    <button class="st-button">Stellar!</button>
+  </body>
+</html>
+```
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+[stellar-example]: https://nasa-jpl.github.io/stellar/example/