path: root/README.rst

Notekins
========

note + -kin (Germanic diminutive suffix), a short note.

*A minimal micro-blogging system without the social media aspect.*

Features
--------

* Post stuff of unlimited length using markdown.
* Emote support. Bring any emotes you wish to use with Notekins.
* Media shelf. You may attach media files to your posts (only images
  for now). Image thumbnail will be automatically generated to save
  bandwidth.
* Automatic Atom feed generation.
* Import archived tweets from Twitter with one simple command (not yet
  implemented).
* Default front-end is completely JavaScript-free.

Notekins isn't for you if you match any of the following ... (these are
ruled out in the project planning phase as anti-features):

* Crave interaction from other Internet-dwellers. Notekins is designed
  to be a strictly single-user system without any support for viewer
  interactions. This include replying, "liking", and collection of
  visitor analytics.
* Need support for ActivityPub integration. Follows naturally from the
  last point
* Are capable of making multiple posts in a single second. Notekins use
  timestamps as unique identifier for posts.

Technical Information
---------------------

Notekins has two major components: a local utility, and a server-side
CGI executable. The local utility is written in Python, while the latter
is developed using Rust. Your posts are saved in the way they are typed
out. They are also consolidated into a "monolith" file and two accompanying
index files, which are used by the CGI program.

The local utility is responsible for managing your posts. It can also
help you setup new instances of Nokekins, publish your posts to your
server, and perform a variety of maintenance tasks on the monolith file.

Deploying Notekins
------------------

As Notekins is still in its early stage, the instructions here might be
outdated at any time.

(TODO)