update readme
This commit is contained in:
parent
6f78e10132
commit
d04d96cf94
1 changed files with 9 additions and 5 deletions
14
README.md
14
README.md
|
|
@ -3,22 +3,26 @@
|
||||||
A simple tool to upload images to s3 and provide image service transformation urls.
|
A simple tool to upload images to s3 and provide image service transformation urls.
|
||||||
|
|
||||||
Written in Clojure via Babashka. Interactive elements are powered by [Gum](https://github.com/charmbracelet/gum).
|
Written in Clojure via Babashka. Interactive elements are powered by [Gum](https://github.com/charmbracelet/gum).
|
||||||
|
Uses a gum wrapper lib I write [com.travisshears.gum-utils](https://git.travisshears.com/travisshears/gum-utils).
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
`gen` - Pick a recently uploaded image and generate a image service url with max dimension
|
||||||
|
`index` - Scrape s3 for images and add them to local db
|
||||||
|
|
||||||
## Run dev
|
## Run dev
|
||||||
|
|
||||||
To run commands:
|
To run commands:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ bb -m cli-cms.main create
|
$ bb -m image-service-cli.main gen
|
||||||
```
|
```
|
||||||
|
|
||||||
Or to play around and call individual functions using the REPL:
|
Or to play around and call individual functions using the REPL:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ rlwrap bb repl
|
$ rlwrap bb repl
|
||||||
user=> (require '[cli-cms.create :as command])
|
user=> (require '[image-service-cli.index])
|
||||||
user=> (def mock-snippet {:title "mock snippet from repl" :slug "mock" :tags '("mock") :markdown "# This is a mock"})
|
user=> (image-service-cli.index/run)
|
||||||
#'user/mock-snippet
|
...
|
||||||
user=> (command/create-snippet mock-snippet)
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue