Update README with feature list

This commit is contained in:
Sidney Alcantara
2020-10-04 15:44:18 +11:00
parent b7d6700bf6
commit 0e99dff6aa

View File

@@ -1,16 +1,58 @@
[![Firetable: Combine the power of Firestore with the simplicity of spreadsheets](https://firetable.io/social-image.jpg)](https://firetable.io)
![Commit](https://img.shields.io/github/last-commit/AntlerVC/firetable?color=%23ed4747)
<p align="center">
<a aria-label="License" href="https://github.com/AntlerVC/firetable/blob/master/LICENSE">
<img src="https://badgen.net/github/license/AntlerVC/firetable" />
</a>
<a aria-label="Commits" href="https://github.com/AntlerVC/firetable/commits/develop">
<img src="https://badgen.net/github/last-commit/AntlerVC/firetable/develop" />
</a>
<a aria-label="Firetable CLI" href="https://npmjs.com/package/firetable">
<img src="https://badgen.net/npm/v/firetable" />
</a>
## Firetable UI
</p>
<big>[**Live Demo →**](https://try.firetable.io)</big>
# Features
Supports fields such as images, files, single/multi select, in addition to
standard fields. Functions such as row resizing, CSV data import/export and much
more!
- Spreadsheet interface for viewing Firestore collections, documents, and
subcollections.
![Firetable screenshot](https://firetable.io/demo.gif)
- Add, edit, and delete rows
- Sort and filter by row values
- Resize and rename columns
- 27 different column types.
[Read more](https://github.com/AntlerVC/firetable/wiki/Column-Types)
- Basic types: Short Text, Long Text, Email, Phone, URL…
- Custom UI pickers: Date, Checkbox, Single Select, Multi Select…
- Uploaders: Image, File
- Rich Editors: JSON, Code, Rich Text (HTML)
- Powerful access controls with custom user roles.
[Read more](https://github.com/AntlerVC/firetable/wiki/Role-Based-Security-Rules)
- Supercharge your database with your own scripts.
- Action field: trigger any Cloud Function
- Derivative field: populate cell with value derived from the rest of the
rows values
- Aggregate field: populate cell with value aggregated from the rows
sub-table
- Integrations with external services.
- Connect Table uses Algolia to get a snapshot of another tables row values
- Connect Service uses any HTTP endpoint to get a cell value
## [Live demo →](https://try.firetable.io)
<a href="https://try.firetable.io">
<img align="center" alt="Firetable demo GIF" src="https://firetable.io/demo.gif">
</a>
# Getting started
@@ -19,11 +61,23 @@ To set up Firetable, you must be comfortable with working with the command line.
You must have at least a basic understanding of how to use npm and install npm
packages globally.
Weve created the Firetable CLI to automate the steps required to set up
Firetable.
### [**Read the getting started guide →**](https://github.com/AntlerVC/firetable/wiki/Getting-Started)
# Documentation
Were still working on improving our documentation and writing more
beginner-friendly guides.
[**Documentation on GitHub Wiki →**](https://github.com/AntlerVC/firetable/wiki)
# Issues
[Create issues here.](https://github.com/antlervc/firetable/issues)
![Open issues](https://badgen.net/github/open-issues/AntlerVC/firetable)
[Create issues and bug reports here.](https://github.com/antlervc/firetable/issues)
Make sure to provide console log outputs and screenshots!
# Roadmap and feature requests
@@ -31,10 +85,16 @@ Make sure to provide console log outputs and screenshots!
- [Roadmap](https://github.com/AntlerVC/firetable/wiki/Roadmap)
- [View our ideas and feature requests](https://github.com/AntlerVC/firetable/projects/1)
<br />
---
<br />
# About Antler Engineering
<img src="https://firebasestorage.googleapis.com/v0/b/antler-vc.appspot.com/o/antler-logo.svg?alt=media&token=34db0e2e-1d24-4995-9efa-8bf209c55613" align="right" width="200" height="48" />
Firetable is created and being actively developed by
[Antler Engineering](https://twitter.com/AntlerEng).