Skip to content

Commit

Permalink
chore: release 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nzbin committed Dec 1, 2022
1 parent 631a9e6 commit 5f9df08
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Three Dots

[![Build Status](https://app.travis-ci.com/nzbin/three-dots.svg?branch=master)](https://app.travis-ci.com/nzbin/three-dots)
[![npm](https://img.shields.io/npm/v/three-dots.svg)](https://www.npmjs.com/package/three-dots)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/nzbin/three-dots)
[![Financial Contributors on Open Collective](https://opencollective.com/three-dots/all/badge.svg?label=financial+contributors)](https://opencollective.com/three-dots)
Expand All @@ -14,10 +15,10 @@ $ npm install three-dots --save

## Usage

1. Include the CSS in your file:
1. Import the styles in your Sass file:

```html
<link href="/path/to/three-dots.css" rel="stylesheet">
```scss
@use 'three-dots';
```

2. Add just one `div` tag:
Expand Down Expand Up @@ -47,13 +48,17 @@ dot-stretching

## Customization

1. Checkout this repo and
Customize the dot's size ( color, spacing, etc. ) with Dart Sass API.

```bash
$ npm install
```scss
@use 'three-dots' with (
$dot-width: 20px,
$dot-height: 20px,
...
);
```

2. Customize the dots size ( color, spacing, etc. ) in the `_variables.scss` file.
The available variables and their default values.

```scss
$dot-width: 10px;
Expand All @@ -68,12 +73,6 @@ $dot-after-color: $dot-color;
$dot-spacing: $dot-width + $dot-width/2;
```

3. Compile Sass files

```bash
$ npm run build
```

## Contributors

### Code Contributors
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "three-dots",
"version": "0.2.3",
"version": "0.3.0",
"description": "CSS loading animations made with single element",
"main": "./_index.scss",
"files": [
Expand Down

0 comments on commit 5f9df08

Please sign in to comment.