# git-effect

Latest version **1.0.2** (published 2020-02-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install git-effect
pnpm add git-effect
yarn add git-effect
bun add git-effect
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-02-10 |
| First published | 2020-02-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 386.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | iGorG, 2020 |
| Maintainers | igorg |
| Keywords | git, git-effect, effect, creative |

## Links

- npm: https://www.npmjs.com/package/git-effect
- Repository: https://github.com/igordg777/git-effect
- Homepage: https://github.com/igordg777/git-effect#readme
- Issues: https://github.com/igordg777/git-effect/issues
- npm.io page: https://npm.io/package/git-effect

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.24.0

## Recent versions

- 1.0.2 (latest) — 2020-02-10
- 1.0.1 — 2020-02-10
- 1.0.0 — 2020-02-10

## README

## git-effect

<p align="center">
<img src="./images/git-effect.gif" width="750px" height="300px"/></p>

`This project was created to creatively design your Github profile page, namely its working time module. Using this package, you can write a word, date in the working time module or display one of the predefined pictures.`

`Данный проект создан для креативного оформления страницы Вашего профиля Github, а именно ее модуля рабочего времени. С помощью даного пакета Вы можете написать в модуле рабочего времени какое-либо слово, дату или отобразить один из предустановленных рисунков.`

Подключение:\
In the project directory, you can run: 

### `npm i git-effect`

For using you need require git-effect such as:\
Для создания календаря необходимо подключить пакет в файле js ипользуя:
### `const newEffect = require('git-effect')`
After that you need run your js file such as:\
После подключения передайте желаемый для отображения текст как аргумент в newEffect(), а также желаемый язык календаря (например русский язык - 'ru', параметр необязательный, по умолчанию английский язык):

###`newEffect('your text', 'en')`

Run your js file  (or connect this js file to the html page and run it in a browser).\
Запустите исполняяемый js файл командой `Run` (или подключите данный файл js к html странице и запустите ее в браузере).

File `gitEffect.txt` created. It's containing the calendar of days. If you'll work these days with `GitHub`, the necessary inscription or picture will be displayed in the working time module of your profile.

Теперь создан файл `gitEffect.txt`, содержащиий кадендарь дней. Работая в данные дни с `GitHub`, в модуле рабочего времени Вашего профиля отобразится необходимая Вам надпись или картинка.

To create a picture calendar, use the following commands:\
Для создания календаря картинок, используйте следующие команды:

###`newEffect('#')`
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
<p align="center">
<img src="./images/spider.png" width="250px" height="200px"/></p>
 ____

###`newEffect('+')`

Picture's calendar will create with this command:\
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
  <p align="center">
  <img src="./images/heart.png" width="250px" height="200px"/></p>
____

###`newEffect('@')`
Picture's calendar will create with this command:\
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
 <p align="center">
 <img src="./images/cat.png" width="250px" height="200px"/></p>
____

###`newEffect('*')`
Picture's calendar will create with this command:\
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
 <p align="center">
 <img src="./images/face.png" width="250px" height="200px"/></p>
____

###`newEffect('$')`
Picture's calendar will create with this command:\
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
 <p align="center">
 <img src="./images/packman.jpg" width="250px" height="200px"/></p>
____

###`newEffect('^')`
Picture's calendar will create with this command:\
 При вызове данной команды будет создан каледарь, для отображения следующей картинки:
 
 <p align="center">
 <img src="./images/house.png" width="250px" height="200px"/></p>
____

#### Enjoy using
##### `© iGorG, 2020`

---
_Source: https://npm.io/package/git-effect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._