readme

nicoloboschi · May 20, 2024 · 43de078 · 43de078
1 parent 548c36a
commit 43de078
Showing 1 changed file with 14 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,18 @@
 # `@nicoloboschi/setup-astradb` Github action
 
 This action creates a [DataStax AstraDB](https://www.datastax.com/products/datastax-astra) database.
-To clean up the database, use the `@nicoloboschi/cleanup-astradb` [action](https://github.com/nicoloboschi/cleanup-astradb).
+To clean up the database, use
+the `@nicoloboschi/cleanup-astradb` [action](https://github.com/nicoloboschi/cleanup-astradb).
 
 Related actions:
-- `@nicoloboschi/cleanup-astradb` [action](https://github.com/nicoloboschi/cleanup-astradb): Delete a specific AstraDB database.
-- `@nicoloboschi/cleanup-astradb-env` [action](https://github.com/nicoloboschi/cleanup-astradb-env): Delete databases based on their last usage time.
 
+- `@nicoloboschi/cleanup-astradb` [action](https://github.com/nicoloboschi/cleanup-astradb): Delete a specific AstraDB
+  database.
+- `@nicoloboschi/cleanup-astradb-env` [action](https://github.com/nicoloboschi/cleanup-astradb-env): Delete databases
+  based on their last usage time.
 
 ## Action Inputs
+
 | Input name  | Description                                                                               	                     | Required 	 | Default Value    |
 |-------------|-----------------------------------------------------------------------------------------------------------------|------------|------------------|
 | token       | Astra DB application token. It needs to have enough permissions to create/delete databases in the organization. | true       |                  |
@@ -18,15 +22,15 @@ Related actions:
 | name        | Name of the database to create. If not provided, a name will be generated automatically.                        | false      |                  |
 | name-prefix | Name prefix in case `name` is not set.                                                                          | false      |                  |
 | vector      | Whether to create a Vector database. (true, false)                                                              | false      | true             |
-| keyspace    | "Database default keyspace. Defaults to 'default_keyspace'."                                                    | false      | default_keyspace |
-
+| keyspace    | Database default keyspace. Defaults to 'default_keyspace'.                                                      | false      | default_keyspace |
 
 ## Action Outputs
-| Output name  | Description                           |
-|--------------|---------------------------------------|
-| id           | Full URL API endpoint of the database |
-| api-endpoint | Database ID.                          |
-| name         | Database name.                        |
+
+| Output name  | Description                            |
+|--------------|----------------------------------------|
+| id           | Database ID.                           |
+| api-endpoint | Full URL API endpoint of the database. |
+| name         | Database name.                         |
 
 ## Example