Skip to content

Comments

docs: add example in readme and renaming suggestions#1

Merged
Tahul merged 26 commits intomainfrom
docs/examples
Jun 2, 2025
Merged

docs: add example in readme and renaming suggestions#1
Tahul merged 26 commits intomainfrom
docs/examples

Conversation

@LeCoupa
Copy link
Member

@LeCoupa LeCoupa commented May 30, 2025

Content of the PR

  •  I have reworked the readme to include all examples. It follows the order the current api documentation so it's easy to update.
  • fetchCompaniesCount has been renamed into countCompanies.
  • fetchCompanyBySocials has been renamed into fetchCompanyBySocial.
  • Each endpoint now have an example

Suggestions

  • We should rename createClient into createTcaClient. Or better make it the export default so we can name it anything we want?
  •  For the createClient function, we could rename api-key into create api-token or just token (better as shorter) for app consistency.
  • Can you rebuild?

LeCoupa and others added 26 commits May 30, 2025 11:00
@Tahul Tahul merged commit 03e4f6a into main Jun 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants