Feat: Add readme and vignette #18

Job	Run time
Coverage report / test-coverage-internal	2m 0s
Check current version / macos-latest (release)	2m 55s
Check NN version / macos-latest (R 4.3.1, 2023-10-25)	2m 0s
Check current version / windows-latest (release)	3m 40s
Check NN version / macos-latest (R 4.4.1, 2024-08-06)	2m 1s
Check current version / ubuntu-latest (devel)	2m 15s
Check NN version / windows-latest (R 4.3.1, 2023-10-25)	7m 11s
Check current version / ubuntu-latest (release)	2m 12s
Check NN version / windows-latest (R 4.4.1, 2024-08-06)	2m 39s
Check current version / ubuntu-latest (oldrel-1)	2m 9s
Check NN version / ubuntu-latest (R 4.3.1, 2023-10-25)	25m 3s
Check NN version / ubuntu-latest (R 4.4.1, 2024-08-06)	22m 17s
Megalinter / MegaLinter	2m 40s
Pkgdown site / pkgdown	2m 7s
	1h 21m 9s

Provide feedback