Initial commit

README.md

@@ -0,0 +1,34 @@
+## Table of Contents
+- [About](#-about)
+- [How to Run](#-how-to-run)
+- [License](#-license)
+
+## About
+
+**process-statcan-data** is a set of scripts that helps you load all Statistics Canada data required for data analysis. Specifically this loads:
+
+- **Boundaries**: Geographic boundaries from 2001 to 2021.
+- **Road Network Files**: Road network files from 2001 to 2021.
+- **Health Regions**: Health Regions from 2003 to 2023.
+- **National Address Register**: National Address Register files from 2022 to 2024.
+- **Census of Population**: Census of Population data from 2001 to 2021.
+- **Census of Agriculture**: Census of Agriculture from 2001 to 2021.
+- **National Household Survey**: National Household Survey from 2011 to 2016.
+
+## How to Run
+
+We make use of Dev Container to run the code:
+
+```shell
+# Clone the repository
+git clone https://github.com/dataforcanada/process-statcan-data.git
+
+# Navigate to the project directory
+cd process-statcan-data
+```
+
+## License
+
+This product is distributed under an MIT license.
+
+[Back to top](#top)