added instruction to readme

master
Kostanjevec 2022-06-28 17:14:08 +02:00
parent c57cd62fdf
commit 265fc9cd95
1 changed files with 29 additions and 3 deletions

View File

@ -1,4 +1,30 @@
# contentmatches # Contentmatcher
bla ## Intstructions
blabla Contentmatcher is a GIA prototype that tries to help you engage with your content and share it with other users. It assumes that you have a heap of content that you would like to reconsider. This heap can take many forms such vast libraries of PDFs on your computer or a long lists of bookmarks.
The app will help you get through this content step by step and continue to show you your content again based on the interest you express as well present you with shared contnet. If you and at least one more person express a high interest in an **item** a match will appear on your matches page. There you can send them an email to talk about the **item** your interested in.
### Some definitions:
* An **item** is a unit of content (like a PDF you upload).
* **Items** are private by default but they can be shared.
* A **collection** made up of all your private **items** and the **items** shared with you.
* When you start a new session Contentmatcher will create a **deck**, which is a small part of the **collection**.
### Importing your content
For now you they only way to import content is to upload your PDFs. We're figuring out how to add diffent lists of links like browser bookmarks, liked tweets and "watch later" youtube videos.
### Sessions
Going through sessions is the main activity in using Contentmatcher. A session consists of rating and potentially shareing **items** in a **deck**. You can adjust the size of your **deck** in the settings. In sessions you rate them with yes, maybe, no and delete buttons. It's weird because there is no question, maybe the question posed is: "are you really interested in this **item**?"
There is also the share button. This will create a new **item** with this content for all other users, so it will appear in their **deck**s from now on.
### Matches
If you and at least one other user rate an **item** with a yes then a match will appear on your matches page. There you can send a email to talk.
### Feedback
If you have any questions, feedback, ideas or if you would like contribute, please contact us at gia@kompot.si.
## Build instructions
Comming soon...