Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arj03 committed Aug 25, 2021
1 parent 7061132 commit ad3d6f2
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# 8K demo

WIP
8K demo is an example SSB application made for the svendsolar event
running purely in the browser using [ssb-browser-core]. The aim of the
application is to showcase some of the things we have been building
during the ngi pointer grant.

![Screenshot of 8K demo][screenshot]

8K demo works by allowing users to create their own applications and
share these together with the data to other users connected to the
same [room]. The name 8k comes from the message size limit, meaning
applications can be no larger than 8192 bytes and demo refers to the
golden demoscene days were packing a ton of stuff into a tiny file was
an art in itself.

8K demo uses meta feeds to store information in different feeds. By
doing so allowing for partial replication by selectively downloading
the feeds of a peer you are interested in. By default a few feeds are
created denoted by their feedpurpose:

- 8K/applications, for storing the actual applications
- 8K/chat, for data related to the default chat application
- replication, for communication about what feeds you know about
similar to ssb-friends

Each application should create a feed to store the data related to the
application.

The apps folder contains a few sample applications one can use for
inspiration.

[screenshot]: ./screenshot.jpg
[ssb-browser-core]: https://github.com/arj03/ssb-browser-core
[room]: The idea with the application is that
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad3d6f2

Please sign in to comment.