dagger-readme-badge
Installation
Entrypoint
Types
DaggerReadmeBadge
- addToReadme()
- link()

dagger-readme-badge

Create a shield.io badge for your dagger project.

Installation

dagger install github.com/pjmagee/daggerverse/dagger-readme-badge@daa6feeb6e7b599b6ac5ae202e989fd296212c95

Entrypoint

Return Type

DaggerReadmeBadge !

Arguments

Name	Type	Default Value	Description
rawUrl	String !	-	The URL to the JSON file containing the version information

Example

dagger -m github.com/pjmagee/daggerverse/dagger-readme-badge@daa6feeb6e7b599b6ac5ae202e989fd296212c95 call \
 --raw-url string

func (m *MyModule) Example(rawUrl string) *dagger.DaggerReadmeBadge  {
	return dag.
			DaggerReadmeBadge(rawUrl)
}

@function
def example(raw_url: str) -> dagger.DaggerReadmeBadge:
	return (
		dag.dagger_readme_badge(raw_url)
	)

@func()
example(rawUrl: string): DaggerReadmeBadge {
	return dag
		.daggerReadmeBadge(rawUrl)
}

Types

DaggerReadmeBadge 🔗

Create a shield.io badge for your dagger project.

addToReadme() 🔗

Add the badge to the provided README file.

Return Type

File !

Arguments

Name	Type	Default Value	Description
file	File !	-	A file.

Example

dagger -m github.com/pjmagee/daggerverse/dagger-readme-badge@daa6feeb6e7b599b6ac5ae202e989fd296212c95 call \
 --raw-url string add-to-readme --file file:path

func (m *MyModule) Example(rawUrl string, file *dagger.File) *dagger.File  {
	return dag.
			DaggerReadmeBadge(rawUrl).
			AddToReadme(file)
}

@function
def example(raw_url: str, file: dagger.File) -> dagger.File:
	return (
		dag.dagger_readme_badge(raw_url)
		.add_to_readme(file)
	)

@func()
example(rawUrl: string, file: File): File {
	return dag
		.daggerReadmeBadge(rawUrl)
		.addToReadme(file)
}

link() 🔗

Create a shield.io badge for your dagger project.

Return Type

String !

Example

dagger -m github.com/pjmagee/daggerverse/dagger-readme-badge@daa6feeb6e7b599b6ac5ae202e989fd296212c95 call \
 --raw-url string link

func (m *MyModule) Example(ctx context.Context, rawUrl string) string  {
	return dag.
			DaggerReadmeBadge(rawUrl).
			Link(ctx)
}

@function
async def example(raw_url: str) -> str:
	return await (
		dag.dagger_readme_badge(raw_url)
		.link()
	)

@func()
async example(rawUrl: string): Promise<string> {
	return dag
		.daggerReadmeBadge(rawUrl)
		.link()
}