Skip to content

Commit 582f992

Browse files
committed
minor polishing in README
1 parent a4c5cf5 commit 582f992

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

.github/workflows/typedb.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
2828
make install
2929
make dist
30-
localstack extensions -v install file://$(ls ./dist/localstack_typedb-*.tar.gz)
30+
localstack extensions -v install file://$(ls ./dist/localstack_extension_typedb-*.tar.gz)
3131
3232
DEBUG=1 localstack start -d
3333
localstack wait

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ $ localstack extensions install "git+https://github.com/localstack/localstack-ex
6363
## Official LocalStack Extensions
6464

6565
Here is the current list of extensions developed by the LocalStack team and their support status.
66-
You can install the respective extension by calling `localstack install <Install name>`.
66+
You can install the respective extension by calling `localstack extensions install <Install name>`.
6767

6868
| Extension | Install name | Version | Support status |
6969
|----------------------------------------------------------------------------------------------------| ------------ |---------| -------------- |
@@ -75,6 +75,7 @@ You can install the respective extension by calling `localstack install <Install
7575
| [Miniflare](https://github.com/localstack/localstack-extensions/tree/main/miniflare) | localstack-extension-miniflare | 0.1.0 | Experimental |
7676
| [Stripe](https://github.com/localstack/localstack-extensions/tree/main/stripe) | localstack-extension-stripe | 0.2.0 | Stable |
7777
| [Terraform Init](https://github.com/localstack/localstack-extensions/tree/main/terraform-init) | localstack-extension-terraform-init | 0.2.0 | Experimental |
78+
| [TypeDB](https://github.com/localstack/localstack-extensions/tree/main/typedb) | localstack-extension-typedb | 0.1.0 | Experimental |
7879

7980

8081
## Developing Extensions
@@ -168,7 +169,7 @@ class ReadyAnnouncerExtension(Extension):
168169
name = "my_ready_announcer"
169170

170171
def on_platform_ready(self):
171-
LOG.info("my plugin is loaded and localstack is ready to roll!")
172+
LOG.info("my plugin is loaded and localstack is ready to roll!")
172173
```
173174

174175
### Package your Extension
@@ -227,9 +228,9 @@ Commands:
227228
new Create a new LocalStack extension from the official extension...
228229
```
229230

230-
#### Creating a new extensions
231+
#### Creating a new extension
231232

232-
First, create a new extensions from a template:
233+
First, create a new extension from a template:
233234

234235
```console
235236
% localstack extensions dev new

typedb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This repo contains a [LocalStack Extension](https://github.com/localstack/locals
1515
This extension can be installed directly from this Github repo via:
1616

1717
```bash
18-
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-typedb&subdirectory=typedb"
18+
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=typedb&subdirectory=typedb"
1919
```
2020

2121
## Install local development version

typedb/localstack_typedb/extension.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
class TypeDbExtension(ProxiedDockerContainerExtension):
16-
name = "localstack-typedb"
16+
name = "typedb"
1717

1818
HOST = "typedb.<domain>"
1919
# name of the Docker image to spin up

typedb/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel", "plux>=1.3.1"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "localstack-typedb"
6+
name = "localstack-extension-typedb"
77
version = "0.1.0"
88
description = "LocalStack Extension: TypeDB on LocalStack"
99
readme = {file = "README.md", content-type = "text/markdown; charset=UTF-8"}

0 commit comments

Comments
 (0)