Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with content examples #49

Open
wants to merge 1 commit into
base: 1.x
Choose a base branch
from
Open

Update README with content examples #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ directory.

### public/

If the package provides a root-level directory for web server files, it MUST be
If the package provides a root-level directory for web server files (such as index.php), it MUST be
named `public/`.

This publication does not otherwise define the structure and contents of the
Expand All @@ -79,23 +79,23 @@ directory.

### resources/

If the package provides a root-level directory for other resource files, it MUST
If the package provides a root-level directory for other resource files (such as language files), it MUST
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does also include things like images, CSS, and Javascript doesn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It depends on whether you're using an asset pipeline or not. It becomes too opinionated from this point, so I omitted those, since I believe that this project is not about the content of the folders.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sure, that makes sense. Thanks.

be named `resources/`.

This publication does not otherwise define the structure and contents of the
directory.

### src/

If the package provides a root-level directory for PHP source code files, it
If the package provides a root-level directory for PHP source code files (such as class definitions), it
MUST be named `src/`.

This publication does not otherwise define the structure and contents of the
directory.

### tests/

If the package provides a root-level directory for test files, it MUST be named
If the package provides a root-level directory for test files (such as test cases and database fixtures), it MUST be named
`tests/`.

This publication does not otherwise define the structure and contents of the
Expand Down