v0.2.0

ash-rocks · Mar 23, 2021 · 4799401 · 4799401
1 parent e4f24a6
commit 4799401
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@
 
 [![ASH CSS][ashlogo]][ashlink]
 
-**Modern CSS-only semantic framework with a built-in dark mode. No JavaScript required!**
+**Accessible CSS-only semantic framework with a built-in dark mode. No JavaScript required!**
 
-ASH is a responsive flex-based framework using only CSS. ASH combines classless semantic elements with classed components to build awesome front-ends. ASH requires no JavaScript and weighs in at ~20kb gzipped!
+ASH is a responsive flex-based framework using only CSS. ASH combines classless semantic elements with classed components to build awesome front-ends. ASH requires no JavaScript and weighs in at ~20kb compressed with Brotli!
 
 > This project can be used in production, as it is currently being used is several projects, but please be aware that it is currently in "beta". Once version 1.0.0 is released this message will be removed. Help us find bugs or other issues!
 
@@ -18,19 +18,29 @@ ASH is a responsive flex-based framework using only CSS. ASH combines classless
 There are a few ways to get ASH CSS. You can download a compiled version, use our CDN, with NPM, or clone and build from the source.
 
 ### Compiled CSS
-Download compiled CSS to use in your self-hosted project. This includes compiled and minified CSS files. [Releases](https://github.com/ash-rocks/ash-css/releases)
+Download compiled CSS to use in your self-hosted project. This includes the following files:
 
-### CDN
+- `ash.css` -> compiled and unminified
+- `ash.css.map` -> compiled CSS map
+- `ash.min.css` -> compiled and minified
+
+These files do not include documentation or source files.
+[Releases](https://github.com/ash-rocks/ash-css/releases)
+
+### CDN via jsDelivr
 Use the code below to drop-in ASH CSS to your project from our CDN. The CDN will be cached, minified, and gzipped.
 ```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/ash-rocks/ash-css@0.1.4/dist/ash/ash.min.css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/ash-rocks/ash-css@0.2.0/dist/ash/ash.min.css">
 ```
 
-### NPM
-ASH can be installed in a NodeJS project using NPM.
+### NPM/Yarn
+ASH can be installed in a NodeJS project using NPM or Yarn.
 ```bash
 npm install ash-css --save
 ```
+```bash
+yarn add ash-css
+```
 ```javascript
 import 'ash-css/dist/ash/ash.min.css';
 ```
@@ -43,17 +53,15 @@ cd ash-css
 npm install
 ```
 
-## Running the docs
+## Docs
 After you clone ASH CSS from source code you can run the docs locally. Local docs are totally offline and will be available at http://localhost:8080/
 ```bash
-cd ash-css
 npm run docs
 ```
 
-## Building from source
+## Building
 After you clone ASH CSS from source code you can build your own customized version. All built files will be available in `dist/ash`
 ```bash
-cd ash-css
 npm run build-ash
 ```
 
@@ -74,15 +82,12 @@ After building from source, downloading the compiled release, or using the CDN j
 </html>
 ```
 
-## Customizing ASH CSS
-ASH uses LESS makes it easy to change variables and to exclude unneeded elements, components, and utilities. Almost have of the total size of ASH will be from utilities. All files needed for customization will be found in the `ash` folder. The main LESS file is `ash/ash.less`. Take a look!
-
-- `ash/ash.less` is the main LESS file and has all the includes used to make up ASH CSS. Just comment out lines if they are not needed!
-- `ash/base` includes base classes, resets, the grid system, and the base dark mode
-- `ash/components` includes classed components
-- `ash/elements` includes classless elements
-- `ash/utilities` includes all the extra utilities to extend ASH CSS
-- `ash/variables` includes all the variables used to build ASH CSS
+You can use the included dark mode my adding the `dark` class to the `html` tag. This can be toggled by using JavaScript to add or remove the class from the html tag or by watching the `prefers-color-scheme` media query.
+```html
+<html class="dark">
+...
+</html>
+```
 
 ## Sponsors
 Support this project and possibly other open-source projects by becoming a sponsor. Higher tier sponsor will appear here with a logo and link to your website. [Become a sponsor](https://github.com/sponsors/skuIIs)
@@ -91,4 +96,4 @@ Support this project and possibly other open-source projects by becoming a spons
 >Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
 
 ## Copyright and license
-Code and documentation copyright 2020 the [ASH CSS Authors](https://github.com/ash-rocks/ash-css/graphs/contributors). Code and documentation released under the [MIT](https://github.com/ash-rocks/ash-css/blob/main/LICENSE) License.
+Code and documentation copyright 2021 the [ASH CSS Authors](https://github.com/ash-rocks/ash-css/graphs/contributors). Code and documentation released under the [MIT](https://github.com/ash-rocks/ash-css/blob/main/LICENSE) License.
diff --git a/docs/views/docs/Download.vue b/docs/views/docs/Download.vue
@@ -27,7 +27,7 @@
 
         <section>
           <h2 id="compiled" class="jump"><a href="#compiled"># Compiled CSS</a></h2>
-          <p>Download compiled CSS to use in your self-hosted project. This includes the following files.</p>
+          <p>Download compiled CSS to use in your self-hosted project. This includes the following files:</p>
           <ul class="-circle">
             <li><code>ash.css</code> -> compiled and unminified</li>
             <li><code>ash.css.map</code> -> compiled CSS map</li>
@@ -49,7 +49,7 @@
 
         <section>
           <h2 id="node" class="jump"><a href="#node"># NPM/Yarn</a></h2>
-          <p>ASH can be installed in a NodeJS project using NPM.</p>
+          <p>ASH can be installed in a NodeJS project using NPM or Yarn.</p>
           <pre>
             <code class="language-shell">
               npm install ash-css --save