Public Access
chore: rename keystone to draft
Rename the module, CLI command name, and all references from keystone/basalt to draft, and fix the stale build/README content found along the way.
This commit is contained in:
1 parent
8293794d13
commit
d7e4c554d8
16 files changed
+40
-43
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# Keystone
|
||||
# Draft
|
||||
|
||||
A powerful CLI tool for bootstrapping Go API projects with best practices built-in. Keystone helps you quickly scaffold production-ready Go APIs with support for both HTTP (REST) and gRPC architectures.
|
||||
A powerful CLI tool for bootstrapping Go API projects with best practices built-in. Draft helps you quickly scaffold production-ready Go APIs with support for both HTTP (REST) and gRPC architectures.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -17,8 +17,8 @@ A powerful CLI tool for bootstrapping Go API projects with best practices built-
|
||||
### From Source
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/keystone.git
|
||||
cd keystone
|
||||
git clone [email protected]:FernandoJVideira/draft.git
|
||||
cd draft
|
||||
make build
|
||||
```
|
||||
|
||||
@@ -38,14 +38,14 @@ make windows
|
||||
make win-arm
|
||||
```
|
||||
|
||||
The compiled binary will be named `basalt` (or `basalt.exe` on Windows).
|
||||
The compiled binary will be named `draft_<os>_<arch>` (e.g. `draft_darwin_arm64`, or `draft_windows_amd64.exe` on Windows).
|
||||
|
||||
## Usage
|
||||
|
||||
### Create a New API Project
|
||||
|
||||
```bash
|
||||
keystone new api
|
||||
draft new api
|
||||
```
|
||||
|
||||
This interactive command will:
|
||||
@@ -67,7 +67,7 @@ This interactive command will:
|
||||
### Generate a New Service
|
||||
|
||||
```bash
|
||||
keystone new service
|
||||
draft new service
|
||||
```
|
||||
|
||||
Creates a new service file in `internal/service/` with:
|
||||
@@ -78,7 +78,7 @@ Creates a new service file in `internal/service/` with:
|
||||
### Generate a New Handler
|
||||
|
||||
```bash
|
||||
keystone new handler
|
||||
draft new handler
|
||||
```
|
||||
|
||||
Creates a new handler in the appropriate directory:
|
||||
@@ -88,7 +88,7 @@ Creates a new handler in the appropriate directory:
|
||||
### Generate a Cryptographic Key
|
||||
|
||||
```bash
|
||||
keystone new key
|
||||
draft new key
|
||||
```
|
||||
|
||||
Generates a secure random key for use in your application (default: 32 characters).
|
||||
@@ -96,12 +96,12 @@ Generates a secure random key for use in your application (default: 32 character
|
||||
### Check Version
|
||||
|
||||
```bash
|
||||
keystone version
|
||||
draft version
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
When you create a new project, Keystone generates a structured Go API with:
|
||||
When you create a new project, Draft generates a structured Go API with:
|
||||
|
||||
```
|
||||
your-project/
|
||||
@@ -153,8 +153,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail
|
||||
|
||||
## Author
|
||||
|
||||
Built by LKResuts for internal usage to bootstrap Go APIs.
|
||||
|
||||
---
|
||||
|
||||
**Note:** The binary is compiled as `basalt`, but the CLI tool is referred to as `keystone` in documentation and usage.
|
||||
Built by LKResuts for internal usage to bootstrap Go APIs.
|
||||
Reference in new issue
Block a user