Skip to content

Commit 9f101b6

Browse files
Readme
1 parent 9b81c7c commit 9f101b6

File tree

3 files changed

+12
-24
lines changed

3 files changed

+12
-24
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All Notable changes to `:package_name` will be documented in this file
3+
All Notable changes to `phpunit-snapshot-assertions` will be documented in this file
44

55
## 1.0.0 - 201X-XX-XX
66

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
# Very short description of the package
1+
# Snapshot testing with PHPUnit
22

3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/phpunit-snapshot-assertions.svg?style=flat-square)](https://packagist.org/packages/spatie/phpunit-snapshot-assertions)
44
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5-
[![Build Status](https://img.shields.io/travis/spatie/:package_name/master.svg?style=flat-square)](https://travis-ci.org/spatie/:package_name)
5+
[![Build Status](https://img.shields.io/travis/spatie/phpunit-snapshot-assertions/master.svg?style=flat-square)](https://travis-ci.org/spatie/phpunit-snapshot-assertions)
66
[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/xxxxxxxxx.svg?style=flat-square)](https://insight.sensiolabs.com/projects/xxxxxxxxx)
7-
[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/:package_name)
8-
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
7+
[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/phpunit-snapshot-assertions.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/phpunit-snapshot-assertions)
8+
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/phpunit-snapshot-assertions.svg?style=flat-square)](https://packagist.org/packages/spatie/phpunit-snapshot-assertions)
99

10-
**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
11-
12-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
10+
**Work in progress!**
1311

1412
## Postcardware
1513

@@ -21,25 +19,15 @@ The best postcards will get published on the open source page on our website.
2119

2220
## Installation
2321

24-
**Note:** Remove this paragraph if you are building a public package
25-
This package is custom built for [Spatie](https://spatie.be) projects and is therefore not registered on packagist. In order to install it via composer you must specify this extra repository in `composer.json`:
26-
27-
```json
28-
"repositories": [ { "type": "composer", "url": "https://satis.spatie.be/" } ]
29-
```
30-
3122
You can install the package via composer:
3223

3324
``` bash
34-
composer require spatie/:package_name
25+
composer require spatie/phpunit-snapshot-assertions
3526
```
3627

3728
## Usage
3829

39-
``` php
40-
$skeleton = new Spatie\Skeleton();
41-
echo $skeleton->echoPhrase('Hello, Spatie!');
42-
```
30+
*Todo*
4331

4432
## Changelog
4533

@@ -61,7 +49,7 @@ If you discover any security related issues, please email [email protected] instea
6149

6250
## Credits
6351

64-
- [:author_name](https://github.com/:author_username)
52+
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
6553
- [All Contributors](../../contributors)
6654

6755
## About Spatie

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"description": "Snapshot testing with PHPUnit",
44
"keywords": [
55
"spatie",
6-
":package_name"
6+
"phpunit-snapshot-assertions"
77
],
8-
"homepage": "https://github.com/spatie/:package_name",
8+
"homepage": "https://github.com/spatie/phpunit-snapshot-assertions",
99
"license": "MIT",
1010
"authors": [
1111
{

0 commit comments

Comments
 (0)