Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SlimDeluxe committed Dec 2, 2023
1 parent b793b6e commit eda2c08
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ Implementation of context functions for the PHP gettext extension

![Packagist Version](https://img.shields.io/packagist/v/datalinx/gettext-context)
![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/datalinx/gettext-context)
![Packagist Downloads](https://img.shields.io/packagist/dt/datalinx/gettext-context)
[![Tests](https://github.com/DataLinx/gettext-context/actions/workflows/test-runner.yml/badge.svg)](https://github.com/DataLinx/gettext-context/actions/workflows/test-runner.yml)
[![codecov](https://codecov.io/gh/DataLinx/gettext-context/branch/master/graph/badge.svg?token=A27REX206L)](https://codecov.io/gh/DataLinx/gettext-context)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
![Packagist License](https://img.shields.io/packagist/l/datalinx/gettext-context)
![Packagist Downloads](https://img.shields.io/packagist/dt/datalinx/gettext-context)
[![Tests](https://github.com/DataLinx/gettext-context/actions/workflows/run-tests.yml/badge.svg)](https://github.com/DataLinx/gettext-context/actions/workflows/run-tests.yml)

## About
PHP still lacks full support for gettext, because it does not implement the context functions.
Expand Down Expand Up @@ -35,7 +36,7 @@ echo pgettext('Product', 'Name'); // Echoes "Naziv"
It can be used on lower versions of PHP, but you won't be able to install it with composer (or run tests).

This package is tested for Linux, but it should work for other systems too.
Any Windows and Mac feedback is highly welcome. It would be great if you could make a pull request for testing on those platforms (including the [GitHub workflow](.github/workflows/run-tests.yml)).
Any Windows and Mac feedback is highly welcome. It would be great if you could make a pull request for testing on those platforms (including the [GitHub workflow](.github/workflows/test-runner.yml)).

## Installing
1. Download it with composer: `composer require datalinx/gettext-context`
Expand Down Expand Up @@ -79,7 +80,7 @@ Then run the "Update from code" procedure :)
## Contributing
If you have some suggestions how to make this package better, please open an issue or even better, submit a pull request.

The project adheres to the PSR-4 and PSR-12 standards.
Should you want to contribute, please see the development guidelines in the [DataLinx PHP package template](https://github.com/DataLinx/php-package-template).

### Changelog
All notable changes to this project are automatically documented in the [CHANGELOG.md](CHANGELOG.md) file using the release workflow, based on the [release-please](https://github.com/googleapis/release-please) GitHub action.
Expand Down

0 comments on commit eda2c08

Please sign in to comment.