https://github.com/schascha/bitchify
Just a lightweight dependency-free easter egg for every website, bitch!
https://github.com/schascha/bitchify
easter-egg es6 javascript
Last synced: 2 months ago
JSON representation
Just a lightweight dependency-free easter egg for every website, bitch!
- Host: GitHub
- URL: https://github.com/schascha/bitchify
- Owner: Schascha
- License: mit
- Created: 2019-02-01T08:46:22.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T05:20:20.000Z (about 1 year ago)
- Last Synced: 2024-11-06T17:52:42.730Z (11 months ago)
- Topics: easter-egg, es6, javascript
- Language: TypeScript
- Homepage: https://schascha.github.io/bitchify/
- Size: 4.57 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bitchify
[](https://github.com/Schascha/bitchify/actions)
[](https://www.npmjs.com/package/bitchify)
[](https://packagephobia.com/result?p=bitchify)
> Bitchify your panty pants. Just a lightweight dependency-free easter egg for every website, bitch!
https://schascha.github.io/bitchify/
## Installation
Bitchify is available on [npm](https://www.npmjs.com/package/bitchify):
```bash
npm i bitchify --save
```
## Initialize
```html
```
```javascript
var bitchify = new Bitchify();
```
## Configuration
```javascript
elements: 'h1, h2, h3, h4, h5, h6, p', // String: Selector
pattern: /[\t\n.!?]+$/, // RegExp|String: Replace pattern, e.g. /[^\w]+$/
replace: ', Bitch!', // String: Replacement
before: false, // Boolean: Insert before or after
active: false, // Boolean: Render on page load
hash: 'bitch', // String: Trigger bitchify via hashtag
keyword: 'bitch' // String: Trigger bitchify on keypress
```
## Examples
### Insert at the beginning
```javascript
new Bitchify({
pattern: /[^\w]+$/,
replace: 'Bitch! ',
before: true
}
```
## Development
### Project setup
```
npm install
```
### Compiles for development
```
npm start
```
### Compiles and minifies for production
```
npm run build
```
### Test, lints and fixes files
```
npm test
```
## Bitchify the world as Browser Bookmark
Create bowser bookmark and copy following code as URL:
```html
javascript:if(typeof bitchify==='undefined'){var bitchify,s=document.createElement('script');s.src='https://schascha.github.io/bitchify/dist/js/bitchify.js';s.onload=function() {bitchify=new Bitchify().render();};document.body.appendChild(s);}else{bitchify.render();}
```
## Bugs? 🐛
Please let me know: https://github.com/Schascha/bitchify/issues
## Buy me a Coffee ☕
Support this project and [others](https://github.com/Schascha?tab=repositories) via [PayPal](https://www.paypal.me/LosZahlos). Thanks
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/Schascha/bitchify/releases).
## License
[MIT](./LICENSE)
Copyright (c) 2019 Sascha Künstler