From 7c5ef7fb0e8f5d28393029ed19ec708ff55a7c29 Mon Sep 17 00:00:00 2001
From: Ro <are0h@ubiqueros.com>
Date: Sun, 7 May 2023 13:50:12 -0700
Subject: [PATCH] CSV Export and API instructions

Added descriptions for usage of the site to the about page, including
the first CSV export as well as instructions for using the API to search
for sites programtically.
---
 public/assets/css/global/frame.css | 11 +++++++
 templates/front/about.twig         | 53 ++++++++++++++++++++++++------
 2 files changed, 54 insertions(+), 10 deletions(-)

diff --git a/public/assets/css/global/frame.css b/public/assets/css/global/frame.css
index 8c17c24..173b313 100644
--- a/public/assets/css/global/frame.css
+++ b/public/assets/css/global/frame.css
@@ -68,6 +68,17 @@ a:hover {
   border-bottom: 1px solid var(--secondary);
 }
 
+pre {
+  white-space: pre;
+  background: var(--secondary);
+}
+
+code {
+  background: var(--secondary);
+  color: var(--primary);
+  padding: 3px;
+}
+
 sup {
   background: var(--black);
   color: var(--white);
diff --git a/templates/front/about.twig b/templates/front/about.twig
index 08bc052..9d2d840 100644
--- a/templates/front/about.twig
+++ b/templates/front/about.twig
@@ -1,4 +1,5 @@
 {% extends "base/frame.twig" %}
+
 {% block stylesheets %}
 	<link rel="stylesheet" type="text/css" href="/assets/css/front/start.css?=sdfsdf">
 	{% endblock %}
@@ -9,20 +10,52 @@
 
 			<h2>What is The Bad Space?</h2>
 			<p>The Bad Space project was born from a need to effectively identify instances that house bad actors and are poorly moderated, which puts marginalized communities at risk.
-				<p>
-					It is an extension of the
-					<strong>#fediblock</strong>
-					hashtag created by
-					<a href="https://www.artistmarciax.com/">Artist Marcia X</a>
-					with additional support from
-					<a href="https://digital.rooting.garden">Ginger</a>
-					to provide a catalog of instances that seek to cause harm and reduce the quality of experience in the fediverse.
-				</p>
-
+			</p>
+			<p>
+				It is an extension of the
+				<strong>#fediblock</strong>
+				hashtag created by
+				<a href="https://www.artistmarciax.com/">Artist Marcia X</a>
+				with additional support from
+				<a href="https://digital.rooting.garden">Ginger</a>
+				to provide a catalog of instances that seek to cause harm and reduce the quality of experience in the fediverse.
 			</p>
 			<p>
 				Technical support provided by
 				<a href="https://roiskinda.cool/profile.html">Ro</a>.
 			</p>
+			<h2>How do I use it?</h2>
+			<p>
+				The Bad Space is meant to be a resource for anyone looking to improve the quality of their online experience by creating a tool that catalogs sources for harassment and abuse. There are several options for how it can be used.
+				<h3>Search</h3>
+				To see if a site is listed in the database, use the
+				<a href="/">search feature</a>
+				to search for that URL. If it is in the database, information for that instance will be returned and associated instances if applicable.
+				<h3>CSV Exports</h3>
+				For a list of the current locations being tracked, click on one of the links below to download a dynamically generated CSV file that can be consumed as a blocklist. More formats will be added over time.
+				<br/>
+				<a href="/exports/mastodon">For Mastodon</a>
+				<h3>API</h3>
+				The Bad Space has a public api that can be used to search the database programatically and return results in the JSON format. The API can be accsess at<br/>
+				<code>https://thebad.space/api/v1/search</code>
+				by posting a JSON object with the following format:
+				<code>{"url":"search.url"}</code><br/>
+				Data from API request will be returned in the follow format:<br/>
+
+				<pre>
+<code>{
+"listingCount":1,
+  "locations":
+  [
+    {
+      "url":"search.url",
+      "name":"Instance Name",
+      "description":"instance description",
+      "link":"bad-space-instance-link"
+    }
+  ]
+}</code>
+</pre>
+			</p>
 		</section>
 	{% endblock %}