1.0.0rc3 (#31)

CITATION.cff

@@ -0,0 +1,85 @@
+cff-version: 1.2.0
+title: >-
+  PyRCS: An open-source tool for collecting railway codes
+  used in different UK rail industry systems
+message: >-
+  If you use PyRCS and/or any code from its GitHub
+  repository, please cite it using the metadata provided in
+  this file. For specific version references of PyRCS,
+  please refer to Zenodo
+type: software
+authors:
+  - given-names: Qian
+    family-names: Fu
+    email: q.fu@bham.ac.uk
+    affiliation: University of Birmingham
+    orcid: 'https://orcid.org/0000-0002-6502-9934'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.4026744
+    description: >-
+      This DOI represents all versions of PyRCS, and will
+      always resolve to the latest one.
+repository-code: 'https://github.com/mikeqfu/pyrcs'
+url: 'https://mikeqfu.github.io/pyrcs/'
+repository: 'https://pyrcs.readthedocs.io/'
+repository-artifact: 'https://pypi.org/project/pyrcs/'
+abstract: >-
+  PyRCS is an open-source Python package designed to
+  simplify the collection and management of diverse codes
+  used in different systems within the UK rail industry. It
+  serves as a practical toolkit for researchers,
+  practitioners, and individuals who frequently interact
+  with the Railway Codes website and work extensively with
+  railway codes in the UK. Leveraging the capabilities of
+  the Python programming language, PyRCS enables efficient
+  access to and manipulation of railway code data, enhancing
+  productivity and effectiveness in working with these
+  codes.
+
+  During installation, PyRCS includes a set of pre-packaged
+  data. When users request data from a specific category
+  listed on the Railway Codes website, PyRCS automatically
+  loads the corresponding pre-packaged data for that
+  category by default. Additionally, it provides
+  functionality that enables direct access to the latest
+  data from the data source website, ensuring users can stay
+  updated with the most current information. Furthermore,
+  PyRCS users can conveniently update the relevant
+  pre-packaged data, keeping their data resources
+  synchronized with the latest developments.
+
+  With PyRCS, users can leverage Python's power to
+  streamline workflows and enhance productivity when working
+  with railway codes in the UK rail industry.
+keywords:
+  - Python
+  - Railway
+  - Railway Codes
+  - Bridges
+  - Computer Reservation System
+  - CRS
+  - National Location Codes
+  - NLC
+  - Timing Point Locations
+  - TIPLOC
+  - Station Number Names
+  - STANME
+  - Station Numbers
+  - STANOX
+  - Electrification
+  - Engineer's Line References
+  - ELR
+  - Mileage
+  - Line Of Route
+  - LOR
+  - Railway Line Names
+  - Railway Bridges
+  - Stations
+  - Signal Boxes
+  - Tunnels
+  - Viaducts
+  - Depots
+  - Tracks
+license: MIT
+date-released: '2020-09-12'

README.md

@@ -4,6 +4,7 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrcs)](https://docs.python.org/3/)
 [![License](https://img.shields.io/github/license/mikeqfu/pyrcs)](https://github.com/mikeqfu/pyrcs/blob/master/LICENSE)
 [![Read the Docs - Documentation](https://img.shields.io/readthedocs/pyrcs?logo=readthedocs)](https://pyrcs.readthedocs.io/en/latest/?badge=latest)
+[![GitHub Pages - Documentation](https://img.shields.io/github/actions/workflow/status/mikeqfu/pyrcs/github-pages.yml?logo=github&label=docs)](https://mikeqfu.github.io/pyrcs/)
 [![Codacy - Code Quality](https://app.codacy.com/project/badge/Grade/7369679225b14eaeb92ba40c12c339d5)](https://app.codacy.com/gh/mikeqfu/pyrcs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![DOI](https://img.shields.io/badge/10.5281%2Fzenodo.4026744-blue?label=doi)](https://doi.org/10.5281/zenodo.4026744)
 

docs/source/index.rst

@@ -2,7 +2,7 @@
 PyRCS
 #####
 
-|PyPI - Version| |PyPI - Python Version| |Read the Docs - Documentation| |License| |Codacy - Code Quality| |DOI|
+|PyPI - Version| |PyPI - Python Version| |Read the Docs - Documentation| |GitHub Pages - Documentation| |License| |Codacy - Code Quality| |DOI|
 
 .. |PyPI - Version| image:: https://img.shields.io/pypi/v/pyrcs
     :alt: PyPI - Version
@@ -13,6 +13,9 @@ PyRCS
 .. |Read the Docs - Documentation| image:: https://img.shields.io/readthedocs/pyrcs?logo=readthedocs
     :alt: Read the Docs - Documentation
     :target: https://pyrcs.readthedocs.io/en/latest/?badge=latest
+.. |GitHub Pages - Documentation| image:: https://img.shields.io/github/actions/workflow/status/mikeqfu/pyrcs/github-pages.yml?logo=github&label=docs
+    :alt: GitHub Pages - Documentation
+    :target: https://mikeqfu.github.io/pyrcs/
 .. |License| image:: https://img.shields.io/github/license/mikeqfu/pyrcs
     :alt: License
     :target: https://github.com/mikeqfu/pyrcs/blob/master/LICENSE