From b0fcf5a284978ee84a64c09d9288353b309b3560 Mon Sep 17 00:00:00 2001
From: Nemo <me@captnemo.in>
Date: Tue, 25 Feb 2020 00:19:44 +0530
Subject: [PATCH] Adds HACKING.md

---
 HACKING.md | 12 ++++++++++++
 README.md  |  5 +++++
 2 files changed, 17 insertions(+)
 create mode 100644 HACKING.md

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..f654a11
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,12 @@
+# Generating the regex
+
+1. Download the latest CSV file from <https://data.gov.in/node/85839/download> or <https://data.gov.in/resources/all-india-pincode-directory>.
+2. Copy all the pincodes to a pincodes.txt file
+3. Generate all unique pincodes by running `sort -u pincodes.txt > /tmp/pin.txt`
+4. `npm install`
+5. `node src/generate.js /tmp/pin.txt > regex.txt`
+
+# PHP Release
+
+1. `git tag 1.2.3`
+2. `git push --tags`
\ No newline at end of file
diff --git a/README.md b/README.md
index c7a6a56..e1e08f9 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,11 @@ use PIN\Validator as P;
 P::validate('110011'); // returns true;
 ```
 
+## Contributing
+
+- See [`HACKING.md`](HACKING.md) for some development details.
+- Pull requests are welcome for adding libraries in other languages (in the same repo).
+
 ## License
 
 Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.