Feat: Add readme and vignette #23

Job	Run time
Check current version / macos-latest (release)	2m 31s
Coverage report / test-coverage-internal	1m 38s
Check current version / windows-latest (release)	2m 58s
Check current version / ubuntu-latest (devel)	2m 25s
Check current version / ubuntu-latest (release)	2m 23s
Check NN version / macos-latest (R 4.3.1, 2023-10-25)	2m 1s
Check current version / ubuntu-latest (oldrel-1)	2m 12s
Check NN version / macos-latest (R 4.4.1, 2024-08-06)	1m 51s
Check NN version / windows-latest (R 4.3.1, 2023-10-25)	7m 29s
Check NN version / windows-latest (R 4.4.1, 2024-08-06)	2m 48s
Check NN version / ubuntu-latest (R 4.3.1, 2023-10-25)	24m 33s
Check NN version / ubuntu-latest (R 4.4.1, 2024-08-06)	22m 57s
Pkgdown site / pkgdown	2m 3s
Megalinter / MegaLinter	2m 37s
	1h 20m 26s

Provide feedback