Skip to content

Commit

Permalink
Add 1.0.0 release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Antolius committed Oct 3, 2021
1 parent bdbd186 commit ee97a17
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Starfish
<img align="left" width="64" height="64" src="https://raw.githubusercontent.com/starfish-app/starfish/main/data/icons/64.png">
<h1>Starfish</h1>

A Gemini browser for elementary OS.
A [Gemini](https://gemini.circumlunar.space/) browser made for [elementary OS](https://elementary.io/).

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](COPYING)

![Starfish Screenshot](https://raw.githubusercontent.com/starfish-app/starfish/main/data/default-style.png)
|![Default style Screenshot](https://raw.githubusercontent.com/starfish-app/starfish/main/data/default-style.png)|![Dark style Screenshot](https://raw.githubusercontent.com/starfish-app/starfish/main/data/dark-style.png)|
|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| Starfish browser rendering an introduction to Gemini page | Starfish client with the dark theme rendering its own project page on Gemini |

## About

Starfish is a graphical client for the Gemini protocol built with GTK and Vala. The main goal of the project is to provide a native looking elementary OS application for reading Gemini sites. Read more on the project's Gemini page: [gemini://josipantolis.from.hr/starfish/](gemini://josipantolis.from.hr/starfish/).
Starfish is a graphical client for the Gemini protocol built with GTK and Vala. The main goal of the project is to provide a native elementary OS application for reading Gemini sites, that will make the protocol more accessible to users. Read more on the project's Gemini page: [gemini://josipantolis.from.hr/starfish/](gemini://josipantolis.from.hr/starfish/).

### Status

Starfish is currently in early development stage. It can already be used to surf Geminispace. It renders Gemtext pages and has basic support for viewing images. It supports user input as its defined in the Gemini spec. However, there are many missing features, such as client certificates, subscriptions, favorites, tabs, etc.

One of the missing features is the inclusion in package managers / app stores. Currently the only way to install Starfish is to compile it locally.
Starfish is in active development. It currently supports core of the Gemini specification, including gemtext rendering, and can be used to view images and download other file types. There are still some missing features, such as client certificates, or support for subscribing to gemlogs. There are also UI features that could use improvements, such as adding search for gemtext pages, or improving the image viewing.

## Build

Expand Down
15 changes: 14 additions & 1 deletion data/starfish.appdata.xml.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,21 @@
<summary>Surf the Geminispace</summary>
<description>
<p>Browse Gemini sites on the small internet. Read personal stories and fictional tales. Enjoy written words without flashy distractions. Keep your browsing private and stay safe from tracking.</p>
<p>Starfish is a begginer-friendly desktop client for Gemini protol. It supports all core features of Gemini, such as beautiful rendering of text based content and encrypted communication with servers. On top of those Starfish offers comforts of modern browsers, like local browsing history, tabs and bookmarks.</p>
<p>Starfish is a begginer-friendly desktop client for Gemini protol. It supports all core features of Gemini, such as beautiful rendering of text based content and encrypted communication with servers. On top of those Starfish offers comforts of modern browsers, like local browsing history, tabs and favorites.</p>
</description>
<releases>
<release version="1.0.0" date="2021-10-03">
<description>
<p>Initial release, bringing you features such as:</p>
<ul>
<li>Beautiful rendering of gemtext content, both served over the network via Gemini protocol and read from local files.</li>
<li>In-app rendering of images and a download option for other file types that you might encounter in the Geminispace.</li>
<li>A gentle introduction to Gemini, with pointers on how to get around and discover more content.</li>
<li>Stuff you'd normally expect from a browser, like tabs, favorites, history-based navigation, etc.</li>
</ul>
</description>
</release>
</releases>
<custom>
<value key="x-appcenter-color-primary">#FFBC8F</value>
<value key="x-appcenter-color-primary-text">#1D3963</value>
Expand Down

0 comments on commit ee97a17

Please sign in to comment.