From 36ff41a474f62e4acc0637165f384e70cc48b395 Mon Sep 17 00:00:00 2001
From: Folke <51116221+mathiaspalmqvist@users.noreply.github.com>
Date: Fri, 30 Sep 2022 14:52:08 +0100
Subject: [PATCH] Create readme.md

---
 readme.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2af683b
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,20 @@
+## How to install
+1. Install the package `composer require mathiaspalmqvist/laravel-cision-feed`
+2. add the cision company slug to `LARAVEL_CISION_FEED_SLUG` at your env
+
+## Functions
+
+`LaravelCisionFeed::all();`
+Returns everyting from the feed.
+
+`LaravelCisionFeed::press();`
+Returns all press releases from the feed.
+
+`LaravelCisionFeed::financial();`
+Returns all financial reports from the feed.
+
+`LaravelCisionFeed::news();`
+Returns all news from the feed.
+
+`LaravelCisionFeed::media();`
+Returns all media from the feed.