Skip to content

Commit

Permalink
Merge pull request #18 from rosswintle/pr/15-1
Browse files Browse the repository at this point in the history
  • Loading branch information
rosswintle authored May 2, 2022
2 parents 1a6eac3 + 4f035b7 commit 46147d9
Show file tree
Hide file tree
Showing 10 changed files with 1,758 additions and 871 deletions.
6 changes: 6 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Ignore artifacts:
build
coverage
dist
node_modules
images
1 change: 1 addition & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,24 @@ and more will be added over time.
I would love you to pull-request any missing or incorrect data.

It's built with:
- [AlpineJS](https://alpinejs.dev)
- [TailwindCSS](https://tailwindcss.com)
- (Ironically) ZERO PHP was used.

- [AlpineJS](https://alpinejs.dev)
- [TailwindCSS](https://tailwindcss.com)
- (Ironically) ZERO PHP was used.

## Setup and build

If you want to contribute there is a very simple build process that will hopefully stand the test of time.

Start by:

* Cloning the repository
* Running `npm install`
- Cloning the repository
- Running `npm install`

Then to build the CSS using Tailwind you can either:

* `./build.sh` for a one off build or
* `./watch.sh` to run a file watcher
- `./build.sh` for a one off build or
- `./watch.sh` to run a file watcher

There is no hot reloading or anything like that.

Expand All @@ -51,21 +52,21 @@ I am manually curating the list of features and related content here. And I'd lo

Features to add to the list will need to meet the following criteria:

* They were added, deprecated or removed in PHP version 5.6 or greater.
- They were added, deprecated or removed in PHP version 5.6 or greater.

PHP features are listed in `features.js`. Hopefully the format of this makes sense. But for reference

* the whole thing is a JSON array
* each entry is an object with the following properties:
* `name`: The name of the feature - plain text only
* `description`: A description of the feature - HTML is allowed, but may not be styled. `<code>` tags are fine and backticks will be converted to code tags.
* `keywords`: An array of strings. These are used when searching, so add strings that people may use to search for this feature.
* `added`: A string for the version of PHP that the feature was added. Must be in the format `X.Y`, e.g. `7.0`. Use `0.0` if this is not known or appropriate.
* `deprecated`: A string for the version of PHP that the feature was deprecated. Must be in the format `X.Y`, e.g. `8.0`. Use `null` if this is not know or appropriate.
* `removed`: A string for the version of PHP that the feature was removed. Must be in the format `X.Y`, e.g. `8.2`. Use `null` if this is not know or appropriate.
* `resources`: This is an array of objects representing links to documentation or articles about the feature. Each link object has the following properties:
* `name`: The title of the link
* `url`: The URL of the link
- the whole thing is a JSON array
- each entry is an object with the following properties:
- `name`: The name of the feature - plain text only
- `description`: A description of the feature - HTML is allowed, but may not be styled. `<code>` tags are fine and backticks will be converted to code tags.
- `keywords`: An array of strings. These are used when searching, so add strings that people may use to search for this feature.
- `added`: A string for the version of PHP that the feature was added. Must be in the format `X.Y`, e.g. `7.0`. Use `0.0` if this is not known or appropriate.
- `deprecated`: A string for the version of PHP that the feature was deprecated. Must be in the format `X.Y`, e.g. `8.0`. Use `null` if this is not know or appropriate.
- `removed`: A string for the version of PHP that the feature was removed. Must be in the format `X.Y`, e.g. `8.2`. Use `null` if this is not know or appropriate.
- `resources`: This is an array of objects representing links to documentation or articles about the feature. Each link object has the following properties:
- `name`: The title of the link
- `url`: The URL of the link

A sample entry:

Expand Down
Loading

0 comments on commit 46147d9

Please sign in to comment.