Update README

README.md

@@ -1,34 +1,42 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
-
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
+<h1 align="center"><a href="https://lesesalen.github.io/ordbok/">ordbok</a></h1>
+<p align="center">
+    <a href="https://github.com/lesesalen/ordbok/actions"><img alt="GitHub Actions Status" src="https://github.com/lesesalen/ordbok/workflows/pipeline/badge.svg" /></a>
+</p>
+
+<p align="center">
+    <b>Ever been confused by words and phrases used at informatics? Look no further</b>
+</p>
+
+<p align="center">
+</p>
+
+## Contributing
+
+Add your phrases and words to `./lib/entries.json` using the following format:
+
+```ts
+{
+  // The actual name of the entry
+  name: string;
+  // Aliases, or commonly used nicknames
+  aliases?: Array<string>;
+  // Keywords for the entry, e.g. course, editor
+  keywords?: Array<string>;
+  // A description for it
+  description: string;
+}
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
-
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+Look in the file itself for examples, or use the following as a simple example:
 
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
+```json
+{
+  "name": "Mitt UiB",
+  "aliases": ["mitt", "MittUiB"],
+  "description": "UiB sitt internsystem for fag, kommunikasjon, innleveringer etc"
+},
+```
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## LICENSE
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+MIT