Feat: Add readme and vignette #26

Job	Run time
Coverage report / test-coverage-internal	1m 37s
Check current version / macos-latest (release)	2m 14s
Check current version / windows-latest (release)	4m 6s
Check current version / ubuntu-latest (devel)	3m 20s
Check current version / ubuntu-latest (release)	2m 21s
Check current version / ubuntu-latest (oldrel-1)	2m 39s
Check NN version / macos-latest (R 4.3.1, 2023-10-25)	1m 53s
Check NN version / macos-latest (R 4.4.1, 2024-08-06)	2m 6s
Check NN version / windows-latest (R 4.3.1, 2023-10-25)	6m 56s
Check NN version / windows-latest (R 4.4.1, 2024-08-06)	3m 38s
Check NN version / ubuntu-latest (R 4.3.1, 2023-10-25)	25m 15s
Check NN version / ubuntu-latest (R 4.4.1, 2024-08-06)	22m 26s
Megalinter / MegaLinter	2m 26s
Pkgdown site / pkgdown	2m 21s
	1h 23m 18s

Provide feedback