Update README.md

README.md

@@ -1,3 +1,72 @@
----
-license: cc-by-sa-4.0
----
+---
+license: cc-by-4.0
+task_categories:
+- feature-extraction
+language:
+- en
+tags:
+- finance
+- reddit
+- social-media
+- sentiment-analysis
+- s&p500
+pretty_name: Reddit Finance Posts SP50
+size_categories:
+- 100K<n<1M
+---
+# Reddit Finance Posts Dataset (Apple, Tesla, Microsoft)
+
+This dataset contains 431,923 Reddit posts collected from 20 finance-related subreddits via the Reddit API.
+As keywords, all S&P 500 companies were used. The included subreddits are:
+
+```
+stocks, wallstreetbets, investing, StockMarket, options, RobinHood,
+pennystocks, SecurityAnalysis, personalfinance, Dividends, CryptoCurrency,
+CryptoMarkets, ETFs, FinancialIndependence, ValueInvesting, quant,
+algotrading, forex, economy, Superstonk, spacs, financialplanning
+```
+
+## About This Dataset
+
+The provided data collection pipeline (see [**emilpartow/financial-sentiment-pipeline**](https://github.com/emilpartow/financial-sentiment-pipeline)) makes it simple to expand the dataset with more comments, different time frames, additional companies, or other subreddits as needed.
+
+If you need a larger or customized dataset, you can easily adapt and rerun the pipeline to collect more data for your own use case.
+
+## Dataset Overview
+
+Each row in the dataset contains metadata and content for a Reddit comment or post, with the following columns:
+
+- `id`: Reddit post ID  
+- `title`: Title of the post  
+- `text`: Body text of the post (if available)
+- `created_utc`: Timestamp in UTC  
+- `created_datetime`: Datetime (ISO format)  
+- `author`: Reddit username  
+- `score`: Reddit score (upvotes minus downvotes)  
+- `num_comments`: Number of comments (for posts)  
+- `upvote_ratio`: Upvote ratio (for posts)  
+- `flair`: Post  flair (if available)  
+- `permalink`: Direct Reddit link to the comment or post  
+- `url`: URL (if different from permalink)  
+- `subreddit`: Name of the subreddit  
+- `company`: The matched company keyword (e.g. `Apple`, `Tesla`, or `Microsoft`)
+
+## Data Collection
+
+All posts were collected using [PRAW (Python Reddit API Wrapper)](https://praw.readthedocs.io/).  
+Data processing pipeline can be found here:  
+➡️ [**emilpartow/financial-sentiment-pipeline**](https://github.com/emilpartow/financial-sentiment-pipeline)
+
+## Notes
+
+- **No manual or verbal content review was performed:** The dataset consists of comments as collected via the Reddit API. There may be offensive, biased, or otherwise inappropriate content present.
+- Please respect Reddit’s API Terms of Use when working with this dataset.
+
+## License
+
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+
+---
+
+**Questions or feedback?**  
+Feel free to open an issue or discussion in the linked GitHub repository!