diff --git a/README.md b/README.md index 90b90cc..4f5eb02 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,39 @@ A design system for building faithful recreations of old UIs. ![a screenshot of a window with the title "My First VB4 Program" and two buttons OK and Cancel, styled like a Windows 98 dialog](https://github.com/jdan/98.css/blob/master/docs/window.png?raw=true) -### Installation +98.css is a CSS file that takes semantic HTML and makes it look pretty. It does not ship with any JavaScript, so it is compatible with your frontend framework of choice. Here is an example of [98.css being used with React](https://codesandbox.io/s/objective-chandrasekhar-t5t6h?file=/src/index.js). -You can grab 98.css from npm. +### Installation / Usage + +The easiest way to use 98.css is to import it from [unpkg](https://unpkg.com/). + +``` + + + + 98.css example + + + + + +
+
+
+ My First VB4 Program +
+
+
+

Hello, world!

+
+
+ + +``` + +Here is an example of [98.css being used with React](https://codesandbox.io/s/objective-chandrasekhar-t5t6h?file=/src/index.js), and [an example with vanilla JavaScript](https://codesandbox.io/s/late-sound-miqho?file=/index.html). The fastest way to use 98.css is to import it from unpkg. + +Alternatively, you can grab 98.css for [the releases page](https://github.com/jdan/98.css/releases) or [npm](https://www.npmjs.com/package/98.css) ``` npm install 98.css diff --git a/docs/index.html b/docs/index.html index a54f17a..535d55a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -95,6 +95,13 @@ This means 98.css is compatible with your frontend framework of choice.

+

+ Here is an example of 98.css used with React, and + an example with vanilla JavaScript. The fastest way to use 98.css is to import it from unpkg. +

+ +
<link rel="stylesheet" href="https://unpkg.com/98.css">
+

You can install 98.css from the GitHub releases page, or from npm.

diff --git a/docs/index.html.ejs b/docs/index.html.ejs index 37461b5..2221084 100644 --- a/docs/index.html.ejs +++ b/docs/index.html.ejs @@ -95,10 +95,17 @@ This means 98.css is compatible with your frontend framework of choice.

+

+ Here is an example of 98.css used with React, and + an example with vanilla JavaScript. The fastest way to use 98.css is to import it from unpkg. +

+ +
<link rel="stylesheet" href="https://unpkg.com/98.css">
+

You can install 98.css from the GitHub releases page, or from npm.

-
npm install 98.css
+
npm install 98.css

Components

diff --git a/package.json b/package.json index 28a8bd2..f9129bd 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "98.css", "version": "0.1.0", "description": "A design system for building faithful recreations of old UIs", - "main": "build/style.css", + "main": "build/98.css", "directories": { "doc": "docs" },