# Awesome [Topic] [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

> [A short, specific description of the list. Example: "A curated list of
> tools, libraries and learning resources for building local-first web
> applications."]

<!--
Guidance: How to use this template
- Follows the conventions of the awesome manifesto and list guidelines
  maintained at github.com/sindresorhus/awesome. Read them before submitting.
- Curate, do not collect: include only resources you would recommend to a
  friend, and say why in the description.
- Every entry uses exactly: - [Name](https://link) - Description.
  The description starts with a capital letter and ends with a full stop.
- Run `npx awesome-lint` in the repository before every release of the list.
- Delete the "About this template" section before publishing.
-->

[One or two sentences of extra context: who the list is for, what is in
scope and what is deliberately left out. Example: "This list covers
open-source projects that keep user data on the device by default. Hosted
services that require an account are out of scope."]

## Contents

- [Libraries](#libraries)
- [Tools](#tools)
- [Articles](#articles)
- [Talks](#talks)
- [Related lists](#related-lists)

## Libraries

Projects to use in your own code, sorted alphabetically within each group.

### Data synchronisation

- [Example Sync](https://github.com/[org]/[example-sync]) - CRDT-based sync engine with a pluggable transport.
- [Example Store](https://github.com/[org]/[example-store]) - Reactive IndexedDB wrapper with offline queries.

### Storage

- [Example DB](https://github.com/[org]/[example-db]) - Embedded SQL database compiled to WebAssembly.
- [Name](https://example.com) - Description ending with a full stop.

## Tools

- [Example Inspector](https://github.com/[org]/[example-inspector]) - Browser extension to inspect local databases.
- [Name](https://example.com) - Description ending with a full stop.

## Articles

- [Local-first software](https://example.com/local-first) - Essay that defines the seven ideals of local-first apps.
- [Name](https://example.com) - Description ending with a full stop.

## Talks

- [Building offline apps](https://example.com/talk) - Conference talk on conflict resolution in practice.

## Related lists

- [Awesome Related Topic](https://github.com/[org]/[awesome-related]) - Neighbouring topic with some overlap.

## Contributing

Contributions are welcome. Read the [contribution guidelines](contributing.md)
first. In short:

- Search previous suggestions before making a new one, to avoid duplicates.
- Make one pull request per suggestion and use the title format `Add [Name]`.
- The resource must be useful, actively maintained, and documented in English.
- Use the entry format `- [Name](link) - Description.` and keep the description concise.
- Add the entry at the end of the relevant category, or alphabetically if the category is sorted.
- Check spelling and grammar, and remove trailing whitespace.

## About this template

This section explains the conventions and should be removed before
publishing.

- **Name.** Lists are named `awesome-[topic]` as a repository and
  `Awesome [Topic]` as the heading, with the Awesome badge to the right of
  the title.
- **Scope.** A list should be about one focused topic and be useful to more
  than its author. Avoid lists that only collect links without judgement.
- **Contents.** The table of contents is titled `Contents` and links to
  the H2 sections in order.
- **Licence.** Add a `LICENSE` file to the repository. The awesome
  guidelines recommend [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
  for lists so anyone can reuse the content. Code licences such as MIT are
  not intended for lists of links.
- **Files.** Add `contributing.md` with the rules above and a code of
  conduct.
- **Submitting.** After the list is at least 30 days old and linted clean,
  it can be proposed to the main awesome list following its pull request
  rules.

## Standard and licence note

Based on the awesome manifesto and list guidelines published at
https://github.com/sindresorhus/awesome (entry format, Contents section,
badge, contribution file and CC0 recommendation). Original text written
for this collection; example entries are placeholders. Template licence:
MIT.
