Skip to content

Commit

Permalink
Remove non-code files from release archive (#25)
Browse files Browse the repository at this point in the history
See: #24
  • Loading branch information
sanmai authored Sep 27, 2023
1 parent 0b3b6a3 commit 5333df2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 1 deletion.
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/.* export-ignore
/Makefile export-ignore
/*.dist export-ignore
/phpcs.xml export-ignore
/tests export-ignore
/example export-ignore
/extras export-ignore
/config export-ignore

# Test with:
# git archive --format=tar HEAD | tar t
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ StreamBuilder expects PHP 7.4+.

Install StreamBuilder by using [Composer](https://getcomposer.org/) and running `composer require automattic/stream-builder` in your project.

To access the examples and unit tests, please use `composer require --prefer-source automattic/stream-builder` to make a local git clone.

## Contributing

If you want to change the StreamBuilder code, please:
Expand Down
2 changes: 1 addition & 1 deletion docs/StreamBuilder-Beginners-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ As an example of how to use StreamBuilder, we will implement an endpoint to retr

Let's also assume the returned array is a simple `string[]` which contains trending topics as strings.

We also have an example demo application in the `example/` folder which implements a lot of what we're going to discuss here -- so check that out!
We also have an example demo application in the `example/` folder which implements a lot of what we're going to discuss here -- so check that out! You must clone the Git repository to work with the example, as released archives do not include example code.

### Integrating StreamBuilder with your codebase

Expand Down
2 changes: 2 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is an example app of MyAwesomeReader implementing StreamBuilder.

Please note this example isn't bundled with the released archives: please make a local git clone.

In this example, we implement an endpoint for trending topics that uses a `Stream`, `StreamElement`, and a `Cursor`.

Usage is:
Expand Down

0 comments on commit 5333df2

Please sign in to comment.