Update README.md

README.md

@@ -1,2 +1,54 @@
 # SubjectsPlus-shortcode
 Repository for the integration of the SubjectsPlus 4.6 with WordPress 6.4. A custom plugin for WordPress using SubjectsPlus API with using shortcodes
+
+Subjectsplus Shortcodes for Wordpress 6.4
+========================================
+
+This Wordpress plugin enables shortcodes that can be used to display data 
+from the subjectsplus API. 
+
+Setup
+----------------------------------------
+
+1. Download the files and place them in your Wordpress plugins folder and activate the plugin
+2. After activating the plugin and configuring the SubjectsPlus API KEY and API URL in the WordPress admin dashboard, look for the menu item named "SubjectsPlus4.6". It should appear in the left sidebar menu of the WordPress dashboard.
+4. Use the shortcodes in your WordPress pages or posts to display the SubjectsPlus data.
+
+
+Shortcode usage
+-----------------------------------------
+
+The shortcodes use a simple syntax. Each subjectsplus shortcode starts begins with sp:
+	[sp]
+
+
+	[sp service='staff' display='table' max='10']
+
+
+This shortcode will query the SubjectsPlus API for staff information and display the results in a table format. You can customize the parameters based on your needs:
+
+    service: Specifies the type of service (e.g., "staff").
+    display: Specifies the display format ("table" or "card").
+    max: Specifies the maximum number of records to retrieve.
+
+To query the api, you need to choose a service. Currently, subjectsplus has 5 available services. This plugin currently allows you to get staff, guides, and database information. 
+
+	[sp service='staff']
+
+	[sp service='guides']  --- upcoming version
+
+	[sp service='database'] --- upcoming version
+
+
+
+
+Staff shortcodes
+-------------------------------------------
+This shortcode returns information about a single staff member and displays it without using a table:
+
+	[sp service='staff' email='[email protected]' display='table']
+
+This shortcode returns information about an entire department and displays it as a table:
+
+	[sp service='staff department='99' display='table']
+