Skip to content

Commit

Permalink
docs: add default readme
Browse files Browse the repository at this point in the history
  • Loading branch information
igzard committed Jan 14, 2025
1 parent 49cfee0 commit 1153855
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# php-skeleton
# Huncity-php

🎉 This **Skeleton PHP** package created for your new package idea
🌐 Searchable hungarian city list PHP library with zip code

<p align="center">
<p align="center">
<a href="https://github.com/igzard/php-skeleton/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/igzard/php-skeleton/tests.yml?label=tests&style=flat-square" alt="Tests passed"></a>
<a href="https://packagist.org/packages/igzard/php-skeleton"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/igzard/php-skeleton"></a>
<a href="https://packagist.org/packages/igzard/php-skeleton"><img alt="Latest Version" src="https://img.shields.io/packagist/v/igzard/php-skeleton"></a>
<a href="https://github.com/igzard/huncity-php/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/igzard/huncity-php/tests.yml?label=tests&style=flat-square" alt="Tests passed"></a>
<a href="https://packagist.org/packages/igzard/huncity-php"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/igzard/huncity-php"></a>
<a href="https://packagist.org/packages/igzard/huncity-php"><img alt="Latest Version" src="https://img.shields.io/packagist/v/igzard/huncity-php"></a>
</p>
</p>

------

> **Requires [PHP 8.3+](https://php.net/releases/)**
⚡️ Create your package using [Composer](https://getcomposer.org):
## Installation

> [!CAUTION]
> This package is under development, so it's not available on packagist yet.
## Contributing

```bash
composer create-project igzard/php-skeleton --prefer-source PackageName
Expand Down Expand Up @@ -45,4 +50,4 @@ make phpstan
make composer-install
```

**Skeleton PHP** was created by **[Gergely Ignácz](https://x.com/igz4rd)** under the **[MIT license](https://opensource.org/licenses/MIT)**.
**Huncity PHP** was created by **[Gergely Ignácz](https://x.com/igz4rd)** under the **[MIT license](https://opensource.org/licenses/MIT)**.
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "igzard/php-skeleton",
"description": "🎉 This skeleton PHP package created for your new package idea",
"name": "igzard/huncity-php",
"description": "Searchable hungarian city list PHP library with zip code",
"type": "library",
"keywords": ["php", "skeleton", "package"],
"keywords": ["php", "hungary", "city", "zip", "list", "varos", "iranyitoszam", "magyar", "telepules"],
"license": "MIT",
"autoload": {
"psr-4": {
"Igzard\\PhpSkeleton\\": "src/"
"Igzard\\HuncityPhp\\": "src/"
}
},
"authors": [
Expand Down

0 comments on commit 1153855

Please sign in to comment.