Skip to content

Commit 779cf67

Browse files
committed
[+]: Improve README.md content
1 parent b9a9d5a commit 779cf67

File tree

1 file changed

+70
-7
lines changed

1 file changed

+70
-7
lines changed

README.md

Lines changed: 70 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
# DotArray
1+
# DotArray - enjoy your :coffee:
22

3-
[![Require `PHP >= 7.1`](https://img.shields.io/badge/Require%20PHP-%3E%3D%207.1-brightgreen.svg)](https://github.com/binary-cube/dot-array)
3+
[![Require `PHP >= 7.1`](https://img.shields.io/badge/Require%20PHP-%3E%3D%207.1-brightgreen.svg)][git-source]
44

55
Accessing PHP Arrays via DOT notation is easy as:
66

77
```php
88
DotArray::create(['config' => ['some.dotted.key' => 'value']])->get('config.{some.dotted.key}')
99
```
10-
[![Latest Stable Version](https://poser.pugx.org/binary-cube/dot-array/version)](https://packagist.org/packages/binary-cube/dot-array)
11-
[![Total Downloads](https://poser.pugx.org/binary-cube/dot-array/downloads)](https://packagist.org/packages/binary-cube/dot-array)
10+
[![Latest Stable Version](https://poser.pugx.org/binary-cube/dot-array/version)][packagist]
11+
[![Total Downloads](https://poser.pugx.org/binary-cube/dot-array/downloads)][packagist]
1212
[![Build Status](https://travis-ci.org/binary-cube/dot-array.svg?branch=master)](https://travis-ci.org/binary-cube/dot-array)
1313
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/003187f2016e4c4cb1b014ccc9bdb5c0)](https://www.codacy.com/app/microThread/dot-array)
1414
[![Code Coverage](https://scrutinizer-ci.com/g/binary-cube/dot-array/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/binary-cube/dot-array/?branch=master)
1515
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/binary-cube/dot-array/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/binary-cube/dot-array/?branch=master)
16-
[![License](https://poser.pugx.org/binary-cube/dot-array/license)](LICENSE)
16+
[![License](https://poser.pugx.org/binary-cube/dot-array/license)][license]
1717

1818
-----
1919

20+
21+
22+
2023
## Installing
2124

2225
- **via "composer require"**:
@@ -38,6 +41,9 @@ DotArray::create(['config' => ['some.dotted.key' => 'value']])->get('config.{som
3841
}
3942
```
4043
44+
45+
46+
4147
## Usage
4248
4349
>##### REMEMBER: YOU NEED TO KNOW YOUR DATA
@@ -205,6 +211,9 @@ DotArray::create(['config' => ['some.dotted.key' => 'value']])->get('config.{som
205211
});
206212
```
207213
214+
215+
216+
208217
### Data Sample:
209218
210219
```php
@@ -269,12 +278,66 @@ $dummyArray = [
269278
];
270279
```
271280
281+
282+
283+
284+
## Bugs and feature requests
285+
286+
Have a bug or a feature request?
287+
Please first read the issue guidelines and search for existing and closed issues.
288+
If your problem or idea is not addressed yet, [please open a new issue][new-issue].
289+
290+
291+
292+
293+
## Contributing guidelines
294+
295+
All contributions are more than welcomed.
296+
Contributions may close an issue, fix a bug (reported or not reported), add new design blocks,
297+
improve the existing code, add new feature, and so on.
298+
In the interest of fostering an open and welcoming environment,
299+
we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone,
300+
regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality,
301+
personal appearance, race, religion, or sexual identity and orientation.
302+
[Read the full Code of Conduct][code-of-conduct].
303+
304+
305+
306+
307+
#### Versioning
308+
309+
Through the development of new versions, we're going use the [Semantic Versioning][semver].
310+
311+
Example: `1.0.0`.
312+
- 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
313+
- 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
314+
- Patch release: increment the third digit. It would fix bugs and keep backward compatibility. E.g. 1.0.1
315+
316+
317+
318+
272319
## Authors
273320

274321
* **Banciu N. Cristian Mihai**
275322

276-
See also the list of [contributors](https://github.com/binary-cube/dot-array/graphs/contributors) who participated in this project.
323+
See also the list of [contributors][contributors] who participated in this project.
324+
325+
326+
277327

278328
## License
279329

280-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
330+
This project is licensed under the MIT License - see the [LICENSE][license] file for details.
331+
332+
333+
334+
<!-- Links -->
335+
[domain]: https://binary-cube.com
336+
[homepage]: https://binary-cube.com
337+
[git-source]: https://github.com/binary-cube/dot-array
338+
[semver]: https://semver.org
339+
[code-of-conduct]: https://github.com/binary-cube/dot-array/blob/master/code-of-conduct.md
340+
[license]: https://github.com/binary-cube/dot-array/blob/master/LICENSE
341+
[contributors]: https://github.com/binary-cube/dot-array/graphs/contributors
342+
[new-issue]: https://github.com/binary-cube/dot-array/issues/new
343+
[packagist]: https://packagist.org/packages/binary-cube/dot-array

0 commit comments

Comments
 (0)