https://github.com/pedroborges/peedo
Speedy navigation for you website and application
https://github.com/pedroborges/peedo
Last synced: about 1 year ago
JSON representation
Speedy navigation for you website and application
- Host: GitHub
- URL: https://github.com/pedroborges/peedo
- Owner: pedroborges
- License: mit
- Created: 2018-07-18T12:31:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-18T12:50:47.000Z (almost 8 years ago)
- Last Synced: 2025-03-07T18:51:07.263Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
peedo
> Tiny 600b fast navigation for you website
- **Tiny:** under **600 bytes** of [ES3](https://unpkg.com/peedo) gzipped
- **Minimal:** covers most use cases without getting in the way
- **Familiar:** mimic the default behaviour
- **Supported:** supports IE11+
- **Standalone:** no dependencies
- **Modern:** written in ES2015, transpiled to 600b of old-school JS
* * *
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)
* * *
## Install
In development...
* * *
## Usage
In development...
* * *
## Contribute
First off, thanks for taking the time to contribute!
Now, take a moment to be sure your contributions make sense to everyone else.
### Reporting Issues
Found a problem? Want a new feature? First of all see if your issue or idea has [already been reported](../../issues).
If it hasn't, just open a [new clear and descriptive issue](../../issues/new).
### Submitting pull requests
Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.
> 💁 **Remember: size is the #1 priority.**
>
> Every byte counts! PR's can't be merged if they increase the output size much.
- Fork it!
- Clone your fork: `git clone https://github.com//peedo`
- Navigate to the newly cloned directory: `cd peedo`
- Create a new branch for the new feature: `git checkout -b my-new-feature`
- Install the tools necessary for development: `yarn`
- Make your changes.
- `yarn build` to verify your change doesn't increase output size.
- `yarn test` to make sure your change doesn't break anything.
- Commit your changes: `git commit -am 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request with full remarks documenting your changes.
## License
[MIT License](LICENSE.md) © [Pedro Borges](https://pedroborg.es)