Skip to content

Commit

Permalink
Update README.md with example.php link and add example.png
Browse files Browse the repository at this point in the history
  • Loading branch information
intelektron committed Jan 15, 2024
1 parent cb7ac26 commit 5c77eca
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# The chordpro-php library 🎸

A simple tool to parse, transpose & format [ChordPro](https://www.chordpro.org) songs with lyrics & chords.
![Workflow status](https://github.com/intelektron/chordpro-php/actions/workflows/codequality.yml/badge.svg)

A simple tool to parse, transpose & format [ChordPro](https://www.chordpro.org) songs with lyrics & chords. Compatible with PHP 8.1 and above.

_Forked from <https://github.com/nicolaswurtz/chordpro-php> by [Nicolaz Wurtz](https://github.com/nicolaswurtz), on LGPL-3 license._

Expand Down Expand Up @@ -29,7 +31,7 @@ composer require intelektron/chordpro-php

## Usage

See [web/example.php] for demo with CSS styling.
See [web/example.php](web/example.php) for demo with CSS styling.

``` php
<?php
Expand Down Expand Up @@ -86,6 +88,8 @@ $monospaced = $monospaceFormatter->format($song, $options);
$json = $jsonFormatter->format($song, $options);
```

![Screenshot](web/example.png)

## Formatting options

Simply give an array with values at true or false for each key/option.
Expand Down Expand Up @@ -120,7 +124,7 @@ $key = $guess->guessKey($song);

## Chord notations

The library supports several chord notations. You can also create your own (by implementing [src/Notation/ChordNotationInterface.php]). Notations are used for both parsing and formatting. So you can parse a song in German notation and display it as French:
The library supports several chord notations. You can also create your own (by implementing [ChordNotationInterface.php](src/Notation/ChordNotationInterface.php]). Notations are used for both parsing and formatting. So you can parse a song in German notation and display it as French:

```php
$txt = 'A typical [fis]German [a]verse';
Expand Down
Binary file added web/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c77eca

Please sign in to comment.