snakke.js icon indicating copy to clipboard operation
snakke.js copied to clipboard

:snake: Reading Position Indicator written in VanillaJS

Snakke


Build Status Standard - JavaScript Style Guide GitHub tag

Reading Position Indicator written in VanillaJS

Features

  • Simple aproach
  • No dependencies
  • < 1kb minified

How to use

1 :heavy_minus_sign: Download the latest release

2 :heavy_minus_sign: Add snakke.min.js (src folder on zip file) before the closing <body> tag:

<script src="path/to/snakke.min.js"></script>

3 :heavy_minus_sign: Add simple rule in your CSS:

.snakke-bar {
  /* Required style */
  position: fixed;
  top: 0;
  left: 0;
  transition: width .3s ease;
  /* Below, your bar style */
  height: 5px;
  background: #2ecc71;
}

Development

  • gulp server :heavy_minus_sign: Server to development (Go to http://localhost:7000)
  • gulp build :heavy_minus_sign: Generate snakke.min.js
  • gulp tag :heavy_minus_sign: Release a new version

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT License :copyright: Diogo Moretti