Feat: Add readme and vignette #22

Job	Run time
Coverage report / test-coverage-internal	1m 32s
Check current version / macos-latest (release)	2m 31s
Check NN version / macos-latest (R 4.3.1, 2023-10-25)	1m 59s
Check NN version / macos-latest (R 4.4.1, 2024-08-06)	2m 13s
Check current version / windows-latest (release)	3m 26s
Check NN version / windows-latest (R 4.3.1, 2023-10-25)	7m 40s
Check current version / ubuntu-latest (devel)	2m 4s
Check NN version / windows-latest (R 4.4.1, 2024-08-06)	3m 10s
Check current version / ubuntu-latest (release)	1m 58s
Check current version / ubuntu-latest (oldrel-1)	2m 4s
Check NN version / ubuntu-latest (R 4.3.1, 2023-10-25)	25m 13s
Check NN version / ubuntu-latest (R 4.4.1, 2024-08-06)	22m 7s
Megalinter / MegaLinter	2m 45s
Pkgdown site / pkgdown	2m 15s
	1h 20m 57s

Provide feedback