Skip to content

Commit

Permalink
📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nabeelvalley committed Dec 9, 2023
1 parent 30c3bfa commit 6857ca8
Showing 1 changed file with 10 additions and 23 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,6 @@

A simple CLI for working with databases during development for quick queries and automation

# Table of contents

<!-- toc -->

- [SQLQ](#sqlq)
- [Table of contents](#table-of-contents)
- [Command Topics](#command-topics)
- [Goals](#goals)
<!-- tocstop -->

<!-- commands -->

# Command Topics

- [`sqlq connection`](docs/connection.md) - Create a connection to a database
- [`sqlq help`](docs/help.md) - Display help for sqlq.
- [`sqlq history`](docs/history.md) - Delete a history entry
- [`sqlq query`](docs/query.md) - Query data from a database by file
- [`sqlq tool`](docs/tool.md) - Create a tool

<!-- commandsstop -->

# Goals

- [x] Manage list of connections
Expand All @@ -34,4 +12,13 @@ A simple CLI for working with databases during development for quick queries and
- [ ] Support terminal based UI for doing all of the application features
- [ ] On the fly creation of databases - SQLite, maybe others

<!-- below content auto generated by oclif, do not edit -->
<!-- commands -->
# Command Topics

* [`sqlq connection`](docs/connection.md) - Create a connection to a database
* [`sqlq help`](docs/help.md) - Display help for sqlq.
* [`sqlq history`](docs/history.md) - Delete a history entry
* [`sqlq query`](docs/query.md) - Query data from a database by file
* [`sqlq tool`](docs/tool.md) - Create a tool

<!-- commandsstop -->

0 comments on commit 6857ca8

Please sign in to comment.