Removed examples main Readme to leave one in each example

This commit is contained in:
Alexander Cerutti
2021-10-31 21:13:00 +01:00
parent a0cdc218dd
commit 41f21b1e08

View File

@@ -1,24 +0,0 @@
# Examples
This is examples folder. These examples are used to test new features and as sample showcases.
Each example is linked to webserver.js, which _requires_ express.js to run.
Express.js has been inserted as "example package" dipendency.
```sh
$ git clone https://github.com/alexandercerutti/passkit-generator.git;
$ cd passkit-generator;
$ npm install;
$ npm run example:install && npm run example:build;
$ npm run example <the-example-you-want-to-execute>;
```
Certificates paths in examples are linked to a folder `certificates` in the root of this project which is not provided.
To make them work, you'll have to edit both certificates and model path.
Visit [http://localhost:8080/gen/examplePass](http://localhost:8080/gen/examplePass) to get the pass. Replace "examplePass" with the pass name in models folder.
Please note that `field.js` example will force you to download `exampleBooking.pass`, no matter what.
---
Every contribution is really appreciated. ❤️ Thank you!