Add a README and fix the declared licence - #159
Merged
Merged
Conversation
chrisjenkinson
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a README describing what the library does at each stage (lexing, parsing, transforming and rendering), with its requirements, how to install it from Packagist, and the development commands.
The usage example lexes a small Markdown-like document, parses it into heading and paragraph nodes, and uses a visitor to give each heading an id. It was run against the current code, and the output shown is its real output.
It also changes the licence in
composer.jsonfrom MIT toGPL-3.0-or-later, which matches the GPL v3LICENSEfile and the author's other packages. Packagist reads the licence fromcomposer.json, so it showed MIT until now.