add type field to github repo
put important stuff in readme at the top