diff --git a/README.md b/README.md index 19f3927..5820292 100644 --- a/README.md +++ b/README.md @@ -2,73 +2,45 @@ [![NPM Version](https://img.shields.io/npm/v/@intergrav/dev.css)](https://www.npmjs.com/package/@intergrav/dev.css) [![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/@intergrav/dev.css)](https://cdn.jsdelivr.net/npm/@intergrav/dev.css/) [![GitHub Repo stars](https://img.shields.io/github/stars/intergrav/dev.css)](https://github.com/intergrav/dev.css) -Tiny, simple, classless CSS framework in the style of Vercel's [Geist](https://vercel.com/geist) design system. Inspired by [xz/new.css](https://github.com/xz/new.css). - -The minified stylesheet weighs only **~4.8kb** and can make any plain HTML file look clean and modern. It also has a light and dark theme. +Tiny, simple, classless CSS framework inspired by Vercel's [Geist](https://vercel.com/geist) design system. It is designed to make any plain HTML file look clean and modern. The minified stylesheet weighs only **~4.8kb** and includes both light and dark themes.
-Preview - +Click to view preview dev.css desktop demo, light mode dev.css desktop demo, dark mode dev.css mobile demo, dark mode dev.css mobile demo, dark mode -
## Importing -In your HTML's `` all you have to write is this, and you're done! (`.min` means to minify the file) +To use dev.css in your HTML, simply add the following line to the `` section of your HTML file: ```html ``` -I also recommend adding a font through [intergrav/fonts](https://github.com/intergrav/fonts). Geist or Inter work with dev.css out of the box. It will use the default system/browser san-serif fonts if those are not available. - -### Geist Font - -```html - -``` - -Recommended monospace variant: - -```html - -``` - -### Inter Font - -```html - -``` +You can also add a font from [intergrav/fonts](https://github.com/intergrav/fonts#readme) to improve the experience, however it will increase the website download size. Geist and Inter fonts work with dev.css out of the box, other fonts will require a theme to be used. If these fonts are not available, the default system/browser sans-serif and monospace fonts will be used, such as Microsoft's Segoe UI or Apple's San Francisco. ## Elements -dev.css takes advantage of semantic HTML elements. Here are some guidelines on how these should be used for the best results. +dev.css takes advantage of semantic HTML elements. Here are some guidelines on how to use them for the best results. ### Header -Use the `
` tag to create a large header for your page. Only use this at the very top of your ``, or else it may look wonky. - -For the title, the header should contain an `

` tag. You can also add an `

` tag before the `

` tag if you want to show extra information. - -If you need a navigation bar, you can add a `