Tuana commited on
Commit
f8c619e
1 Parent(s): d7567fa

short readme

Browse files
Files changed (1) hide show
  1. README.md +25 -1
README.md CHANGED
@@ -7,4 +7,28 @@ sdk: streamlit
7
  sdk_version: 1.25.0
8
  app_file: app.py
9
  pinned: false
10
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  sdk_version: 1.25.0
8
  app_file: app.py
9
  pinned: false
10
+ ---
11
+
12
+ # Hacker News Summaries
13
+
14
+ ### Try it out on [🤗 Spaces](https://huggingface.co/spaces/deepset/hackernews-summaries)
15
+
16
+ ##### A simple app to get summaries of some of the latest top hackernews posts
17
+
18
+ This is a demo just for fun 🥳
19
+ This repo contains a streamlit application that given a number between 1 - 5 gives you summaries of that many of the latest top Hacker News posts.
20
+ It uses a [custom Haytack component](https://docs.haystack.deepset.ai/v2.0/docs/custom-component?utm_campaign=developer-relations)
21
+ It's been built with [Haystack](https://haystack.deepset.ai) using the [`HuggingFaceTGIGenerartor`](https://docs.haystack.deepset.ai/v2.0/docs/huggingfacetgigenerator?utm_campaign=developer-relations) and by creating a [`PromptBuilder`](https://docs.haystack.deepset.ai/v2.0/docs/promptbuilder?utm_campaign=developer-relations)
22
+
23
+
24
+ If you try to run it yourself and find ways to make this app better, please feel free to create an issue/PR 🙌
25
+
26
+ ## Installation and Running
27
+ 1. Install requirements:
28
+ `pip install -r requirements.txt`
29
+ 2. Run the streamlit app:
30
+ `streamlit run app.py`
31
+
32
+ This will start up the app on `localhost:8501` where you will dind a simple search bar
33
+
34
+ #### The Haystack Community is on [Discord](https://discord.com/invite/VBpFzsgRVF)