> For the complete documentation index, see [llms.txt](https://cykadev.gitbook.io/rsspace/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cykadev.gitbook.io/rsspace/rsspace-quickstart.md).

# RSSpace Quickstart

## Introduction

RSSpace was created as an entry for the 2022 Jetbrains Space Application Contest. It's a powerful chatbot application with a full-fledged user interface, easily installable in any Jetbrains Space organization, that allows you to subscribe to unlimited RSS feeds and to get notified whenever new information is accessible.

## Installation

In order to install the plugin into your Jetbrains Space organization, simply head over to its Jetbrains Marketplace page:

{% embed url="<https://plugins.jetbrains.com/plugin/20337-rsspace>" %}
RSSpace plugin page
{% endembed %}

Simply click the "Install to Space" button to install it to your organization. After a few seconds, the application will be ready to go! You can then start using it by either [talking to the chatbot](#chat-commands) (by clicking the "Go to chat bot" button) or by using the [included UI](#user-interface).

<figure><img src="/files/IBPu1DCgGO2CHwK4qh9y" alt=""><figcaption><p>Extension page with "Go to chat bot" button</p></figcaption></figure>

## Usage

### Chat commands

Using RSSpace is extremely easy. You have five available commands:

| Command     | Description                                                                | Usage                         |
| ----------- | -------------------------------------------------------------------------- | ----------------------------- |
| help        | Displays a list of available commands and their usage.                     | `help`                        |
| list        | Displays a list of your currently followed RSS feeds.                      | `list`                        |
| subscribe   | Subscribes to an RSS feed and notifies you whenever new data is available. | `subscribe <URL> <Parameter>` |
| unsubscribe | Unsubscribes from an RSS feed you're following.                            | `unsubscribe <URL> \| <Name>` |
| bookmarks   | Displays all your currently bookmarked items.                              | `bookmarks`                   |

For instance, if you subscribe to TechCrunch (using the command `subscribe` [`https://techcrunch.com/feed/`](https://techcrunch.com/feed/)), you will get notifications resembling this one:

<figure><img src="/files/fSEWwEqgq9VEymh7qccc" alt=""><figcaption><p>Sample RSS notification</p></figcaption></figure>

You can add additional parameters to your subscription command. Here is the list of currently available ones:

| Parameter | Description                                                                                       | Example usage                                                                     |
| --------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Slow mode | Enables [slow mode](/rsspace/frequently-asked-questions.md#what-is-slow-mode) for a subscription. | `subscribe` [`https://techcrunch.com/feed/`](https://techcrunch.com/feed/) `slow` |

And you'll be good to go! You can unsubscribe at any time with the `unsubscribe` command, or list your subscriptions with the `list` command.

{% hint style="info" %}
You can customize the appearance of your RSS notifications by accessing the [user interface](/rsspace/navigating-the-ui.md)!
{% endhint %}

### User Interface

Since update 2, RSSpace comes with a new user interface in order for you to manage your RSS subscriptions more easily. You can access the UI by either going on the installed RSSpace page for your organization and clicking the "Homepage" tab:

<figure><img src="/files/bIbV5JdbwX2MWUOZcb8T" alt=""><figcaption><p>Available tabs</p></figcaption></figure>

Or by enabling the RSSpace Dashboard tab in your Navigation settings:

<figure><img src="/files/Sn4cY5HNPUl9iAZx7yHp" alt=""><figcaption><p>Enabling the RSSpace Dashboard tab</p></figcaption></figure>

Once you access this homepage, you'll be able to manage your RSS subscriptions in a grid format. You just have to press the blue button in the top right corner to create a new one!

<figure><img src="/files/ZO5yx7k8tI2HbCGYTROn" alt=""><figcaption><p>Example followed feeds grid</p></figcaption></figure>

If you encounter issues with the theme (bright background on dark application), please refer to the [Frequently asked questions](/rsspace/frequently-asked-questions.md#why-is-the-ui-theme-messed-up).

You can get more information about the UI in the [Navigating the UI](/rsspace/navigating-the-ui.md) page.

## What's next?

I am constantly trying to improve this plugin to add more features and innovative functions. I do have pretty nice plans for this application!

Now that the UI is available and polished, I'll keep working on incremental updates to make the whole experience smoother and more interesting. That means more RSS customization options, more feed availability and extra tabs to play around with!