Merge pull request #56 from suryavaddiraju/dev

v3.0.1

.github/CONTRIBUTING.md

@@ -11,7 +11,7 @@ following additional notes.
 The GitHub issue tracker is for *bug reports* and *feature requests*. Please do
 not use it to ask questions about how to use irctc-api. These questions should
 instead be directed to [Stack Overflow](https://stackoverflow.com/). Make sure
-that your question is tagged with the `node.js & api` tag when asking it on
+that your question is tagged with the `node.js & api & irctc` tag when asking it on
 Stack Overflow, to ensure that it is answered promptly and accurately.
 
 ## Good Bug Reports

.github/SECURITY.md

@@ -8,7 +8,8 @@ versions of the project that are currently being supported with security updates
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 2.0.x   | :white_check_mark: |
+| 3.0.x   | :white_check_mark: |
+| 2.0.x   | :x:                |
 | 1.0.x   | :x:                |
 
 ## Vulnerability Disclosure

.github/workflows/jekyll-gh-pages.yml

@@ -2,10 +2,6 @@
 name: Deploy Jekyll with GitHub Pages dependencies preinstalled
 
 on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
@@ -28,12 +24,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Copy README.md to docs/
+        run: cp README.md docs/index.md
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
-          source: ./
+          source: ./docs
           destination: ./_site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

.gitignore

@@ -131,5 +131,7 @@ dist
 # working directory files
 captcha.jpg
 viu
-bin
-viu.exe
+bin/
+viu.exe
+playground/
+proxy/

.npmignore

@@ -1,11 +1,8 @@
 .github/
+docs/
 examples/
 test/
 .gitignore
-api_reference.md
-contribution.md
-_config.yml
-captcha.jpg
 captcha.jpg
 viu
 bin/

README.md

@@ -48,15 +48,14 @@ Then provide `viu` binary path in params as
 
 ```json
 {
-  "train_number": "11020",
   "viu":"path/to/binary/viu | path/to/binary/viu.exe"
 }
 ```
 
 
 ### Notes
 
-- Currently this project is designed to accept only UPI Collect request as payment option and other payment modes are not supported as of now. When the payment request is initiated, The command line will display the payment request details such that you need to complete the payment from your UPI mobile App.
+- Currently this project is designed to accept only UPI Collect request and IRCTC wallet as payment option and other payment modes are not supported as of now. When the payment request is initiated, The command line will display the payment request details such that you need to complete the payment from your UPI mobile App for UPI payment method.
 
 ### Import
 
@@ -65,6 +64,12 @@ This Package exports a class named `IRCTC` which contains three functions.
 - book
 - last_transaction
 - pnr_status
+- master_passengers
+
+Other variables export
+- countries
+- stations
+
 
 To send a request, you only need to import the `IRCTC`.
 
@@ -90,7 +95,9 @@ To send a request, you:
 
 ```js
 // a client can be shared by different commands. But it is currently in development untill then use client seperately.
-const client = new IRCTC();
+const client = new IRCTC({
+  // irctc_class_params
+});
 
 const params = {
   // refer https://dev.vaddiraju.in/irctc-api/api_reference#book_input

_config.yml → docs/_config.yml

@@ -5,4 +5,4 @@ author:
 remote_theme: jekyll/minima
 plugins:
 - jekyll-remote-theme
-exclude: [lib/,examples/,test/,.gitignore,.npmignore,index.mjs,LICENSE,package.json,.github/,package-lock.json,_config.yml,"bin/"]
+exclude: [_config.yml]