Skip to content

Commit

Permalink
chore: add script disclaimer and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed Oct 15, 2023
1 parent dbb2b21 commit 754905a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions scripts/rename.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#!/usr/bin/env bash

# This script is used to rename the example repo to the module name of your choice.
# Usage MODULE_NAME=username/repo ./scripts/rename.sh
# Disclaimer: this script do not work with multi-slash module names (e.g. my/awesome/repo) or module names with dashes (e.g. my-awesome-repo)
# If you want to use a multi-slash module name, you will need to manually rename the module name in go.mod and the proto files.
# A typical module name is 'username/proto' omitting the 'github.com/' prefix.

if [[ -z $MODULE_NAME ]]; then
echo "MODULE_NAME must be set."
Expand Down

0 comments on commit 754905a

Please sign in to comment.