Index: update-copyright/README.md |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/update-copyright/README.md |
@@ -0,0 +1,18 @@ |
+# update-copyright |
+ |
+A script that opens each repo listed on [hg.adblockplus.org](https://hg.adblockplus.org/) and updates the copyrights on each page to the current year. |
+ |
+## Usage |
+ |
+Runs the deault script: |
+ $ python3 update_copyright.py |
+ |
+Specify which Mercurial URL site to scrape |
+ $ python3 update_copyright.py -u https://hg.adblockplus.org/ |
+ |
+Specify which Mercurial URL site to scrape and which remote repo to push to |
+ $ python3 update_copyright.py -u https://hg.adblockplus.org/ -p ssh://hg@hg.adblockplus.org/ |
+ |
+## Testing |
+ |
+The tests can be run via [Tox](http://tox.readthedocs.org/) |