update readme

README.md

@@ -1 +1,20 @@
-# SydneyAddressGenerator
+# sydney-bulk-identity-generator
+### Perfect for filling your database with dummy data that looks real!
+
+Small program that generates personal details, such as address, full name, phone number, date of birth, gender, email for a person living in Sydney, Australia.
+
+The user can choose how many details they wish to generate, and the name of the output .csv file.
+
+You can then import that .csv file into your database, for more information read:
+
+- MySQL - https://dev.mysql.com/doc/workbench/en/wb-admin-export-import-table.html
+- Microsoft SQL Server - https://docs.microsoft.com/en-us/sql/relational-databases/import-export/import-flat-file-wizard?view=sql-server-ver15
+- PostgreSQL - https://learnsql.com/blog/how-to-import-csv-to-postgresql/
+- Oracle - https://docs.oracle.com/database/121/ADMQS/GUID-7068681A-DC4C-4E09-AC95-6A5590203818.htm
+
+# Credits
+
+- OpenAddresses - > https://github.com/openaddresses/openaddresses by OpenAddresses. BSD-3-Clause License.
+- CsvHelper - > https://github.com/JoshClose/CsvHelper by Josh Close. Apache 2.0 and MS-PL License.
+- RandomNameGeneratorLibrary - > https://github.com/m4bwav/DotNetRandomNameGenerator by Mark Rogers. MIT Licence.
+- Application icon - > https://www.microsoft.com/en-us/download/details.aspx?id=35825. Allowed under Microsoft EULA.