search

agsh / onvif

ONVIF node.js implementation
http://agsh.github.io/onvif/
MIT License
692 stars 234 forks source link

Move examples to folder and ignore in npm #206

Closed Mudrekh closed 2 years ago

Mudrekh commented 2 years ago

Examples are currently listed in the root of repo which adds to clutter. This PR moves them to a unified examples folder. Additionally, the examples are currently being published to NPM. They should not be in the distributed version of module.

agsh commented 2 years ago

Agree with you

agsh commented 2 years ago

@Mudrekh But you forgot to change README.md and put the links to the new location, can you do this?

RogerHardiman commented 2 years ago

As well as the README, there is also a small error in the actual commit. Example2 is showing as a DELETE and and then a new ADD. This will erase the full commit history of that file. Other changes are marked as 'R' which should keep the change history

File Changes • M .npmignore (3) • D example2.js (188) • R examples/example.js (6) • A examples/example2.js (187) • R examples/example3.js (2) • R examples/example4.js (14) • R examples/example5.js (2) • R examples/example6.js (2) • R examples/example7.js (2)

Mudrekh commented 2 years ago

@agsh What needed to be changed in the README.md? Just point to the examples folder instead of listing files and a changelog entry?

@RogerHardiman Correct, but I slapped this PR together very quickly. Example 2 was just reformatted because of my autolinter and the applied .eslint config, so git no longer recorgizned the files. Is this a big issue? Its just an example file and not operational code