Skip to content

docs: add browsable Sourcey API reference link #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Luvi-1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add browsable Sourcey API reference link #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Go Reference](https://pkg.go.dev/badge/github.com/IBM/fp-go.svg)](https://pkg.go.dev/github.com/IBM/fp-go)
[![Coverage Status](https://coveralls.io/repos/github/IBM/fp-go/badge.svg?branch=main)](https://coveralls.io/github/IBM/fp-go?branch=main)
[![API Docs](https://img.shields.io/badge/API%20docs-sourcey-blue)](https://luvi-1.github.io/fp-go-docs/)

**🚧 Work in progress! 🚧** Despite major version 1 (due to [semantic-release limitations](https://github.com/semantic-release/semantic-release/issues/1507)), we're working to minimize breaking changes.

Expand Down Expand Up @@ -56,6 +57,7 @@ result := function.Pipe2(
### Resources

- 📖 [API Documentation](https://pkg.go.dev/github.com/IBM/fp-go)
- 📚 [Sourcey API Reference](https://luvi-1.github.io/fp-go-docs/) — browsable, searchable API docs
- 💡 [Code Samples](./samples/)
- 🆕 [V2 Documentation](./v2/README.md) (requires Go 1.24+)

Expand Down