Skip to content

Commit 47d3326

Browse files
committed
[+]: Initial commit
1 parent 379e93f commit 47d3326

32 files changed

+3269
-1
lines changed

.editorconfig

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ------------------------------------------- #
2+
# More information at http://editorconfig.org #
3+
# ------------------------------------------- #
4+
5+
6+
# Top-most EditorConfig file
7+
root = true
8+
9+
10+
# Apply To All
11+
[*]
12+
charset = utf-8
13+
end_of_line = lf
14+
indent_style = space
15+
indent_size = 4
16+
trim_trailing_whitespace = true
17+
insert_final_newline = true
18+
max_line_length = 120
19+
20+
21+
[*.md]
22+
trim_trailing_whitespace = false
23+
insert_final_newline = false
24+
25+
26+
[Makefile]
27+
indent_style = tab
28+
29+
30+
[{motd, pre-commit}]
31+
trim_trailing_whitespace = false
32+
insert_final_newline = false
33+
34+
35+
[*.{yml,yaml}]
36+
indent_size = 2

.gitattributes

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Autodetect text files
2+
* text=auto
3+
4+
5+
# ...Unless the name matches the following overriding patterns
6+
7+
# Definitively text files
8+
*.php text
9+
*.css text
10+
*.js text
11+
*.txt text
12+
*.md text
13+
*.xml text
14+
*.json text
15+
*.bat text
16+
*.sql text
17+
*.yml text
18+
*.neon text
19+
20+
21+
# Ensure those won't be messed up with
22+
*.png binary
23+
*.jpg binary
24+
*.gif binary
25+
*.ttf binary
26+
27+
28+
# Ignore some meta files when creating an archive of this repository
29+
/.git export-ignore
30+
/.github export-ignore
31+
/.gitattributes export-ignore
32+
/phpunit.xml export-ignore
33+
/phpcs.xml export-ignore
34+
/phpmd.xml export-ignore
35+
/phpstan.neon export-ignore
36+
/.travis.yml export-ignore
37+
/.scrutinizer.yml export-ignore
38+
/vendor export-ignore
39+
/docs export-ignore

.gitignore

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# --------------------------------------------
2+
# Composer & Vendor Directory.
3+
# --------------------------------------------
4+
composer.phar
5+
/vendor
6+
/composer.lock
7+
8+
9+
# --------------------------------------------
10+
# PHPUnit & Config.
11+
# --------------------------------------------
12+
phpunit.phar
13+
/phpunit.xml
14+
.phpunit.result.cache
15+
/build
16+
17+
18+
# --------------------------------------------
19+
# Local PHP Code Sniffer Config.
20+
# --------------------------------------------
21+
/phpcs.xml
22+
23+
24+
# --------------------------------------------
25+
# Local PHPMD Config.
26+
# --------------------------------------------
27+
/phpmd.xml
28+
29+
30+
# --------------------------------------------
31+
# IDE Files.
32+
# --------------------------------------------
33+
# PhpStorm.
34+
.idea
35+
36+
# NetBeans.
37+
nbproject
38+
39+
# Zend Studio
40+
.buildpath
41+
.project
42+
.settings
43+
44+
45+
# --------------------------------------------
46+
# OS files.
47+
# --------------------------------------------
48+
Thumbs.db
49+
.DS_Store

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog

README.md

Lines changed: 126 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,126 @@
1-
# elastic-tool
1+
# Elastic-Tool 🦖
2+
3+
4+
<p align="center">~ Enjoy your :coffee: ~</p>
5+
6+
[![Minimum PHP Version `PHP >= 7.1`][ico-php-require]][link-php-site]
7+
[![Latest Stable Version][ico-version]][link-packagist]
8+
[![Total Downloads][ico-downloads]][link-downloads]
9+
[![Build Status][ico-travis]][link-travis]
10+
[![Code Coverage][ico-scrutinizer]][link-scrutinizer]
11+
[![Quality Score][ico-code-quality]][link-code-quality]
12+
[![License][ico-license]][link-license]
13+
14+
-----
15+
16+
17+
18+
## Requirements
19+
This package requires the following
20+
- php >= 7.0
21+
22+
23+
24+
25+
## Installing
26+
27+
- **via "composer require"**:
28+
29+
``` shell
30+
composer require binary-cube/elastic-tool
31+
```
32+
33+
- **via composer (manually)**:
34+
35+
If you're using Composer to manage dependencies, you can include the following
36+
in your `composer.json` file:
37+
38+
```json
39+
{
40+
"require": {
41+
"binary-cube/elastic-tool": "0.*"
42+
}
43+
}
44+
```
45+
46+
## Example of usage
47+
```php
48+
// TODO: Add
49+
```
50+
51+
52+
## Bugs and feature requests
53+
54+
Have a bug or a feature request?
55+
Please first read the issue guidelines and search for existing and closed issues.
56+
If your problem or idea is not addressed yet, [please open a new issue][link-new-issue].
57+
58+
59+
60+
61+
## Contributing guidelines
62+
63+
All contributions are more than welcomed.
64+
Contributions may close an issue, fix a bug (reported or not reported), add new design blocks,
65+
improve the existing code, add new feature, and so on.
66+
In the interest of fostering an open and welcoming environment,
67+
we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone,
68+
regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality,
69+
personal appearance, race, religion, or sexual identity and orientation.
70+
[Read the full Code of Conduct][link-code-of-conduct].
71+
72+
73+
74+
75+
#### Versioning
76+
77+
Through the development of new versions, we're going use the [Semantic Versioning][link-semver].
78+
79+
Example: `1.0.0`.
80+
- Major release: increment the first digit and reset middle and last digits to zero. Introduces major changes that might break backward compatibility. E.g. 2.0.0
81+
- Minor release: increment the middle digit and reset last digit to zero. It would fix bugs and also add new features without breaking backward compatibility. E.g. 1.1.0
82+
- Patch release: increment the third digit. It would fix bugs and keep backward compatibility. E.g. 1.0.1
83+
84+
85+
86+
87+
## Authors
88+
89+
* **Banciu N. Cristian Mihai**
90+
91+
See also the list of [contributors][link-contributors] who participated in this project.
92+
93+
94+
95+
96+
## License
97+
98+
This project is licensed under the MIT License - see the [LICENSE][link-license] file for details.
99+
100+
101+
102+
103+
<!-- Links -->
104+
[ico-php-require]: https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=flat-square
105+
[ico-version]: https://img.shields.io/packagist/v/binary-cube/elastic-tool.svg?style=flat-square
106+
[ico-downloads]: https://img.shields.io/packagist/dt/binary-cube/elastic-tool.svg?style=flat-square
107+
[ico-travis]: https://img.shields.io/travis/binary-cube/elastic-tool/master.svg?style=flat-square
108+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/binary-cube/elastic-tool.svg?style=flat-square
109+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/binary-cube/elastic-tool.svg?style=flat-square
110+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
111+
112+
[link-domain]: https://binary-cube.com
113+
[link-homepage]: https://binary-cube.com
114+
[link-git-source]: https://github.com/binary-cube/elastic-tool
115+
[link-packagist]: https://packagist.org/packages/binary-cube/elastic-tool
116+
[link-downloads]: https://packagist.org/packages/binary-cube/elastic-tool
117+
[link-php-site]: https://php.net
118+
[link-semver]: https://semver.org
119+
[link-code-of-conduct]: https://github.com/binary-cube/elastic-tool/blob/master/code-of-conduct.md
120+
[link-license]: https://github.com/binary-cube/elastic-tool/blob/master/LICENSE
121+
[link-contributors]: https://github.com/binary-cube/elastic-tool/graphs/contributors
122+
[link-new-issue]: https://github.com/binary-cube/elastic-tool/issues/new
123+
[link-travis]: https://travis-ci.org/binary-cube/elastic-tool
124+
[link-scrutinizer]: https://scrutinizer-ci.com/g/binary-cube/elastic-tool/code-structure
125+
[link-code-quality]: https://scrutinizer-ci.com/g/binary-cube/elastic-tool
126+
[link-enqueue]: https://github.com/php-enqueue

code-of-conduct.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq
77+

0 commit comments

Comments
 (0)