chatwoot / chatwoot/ios-agent-sdk

Update README to clarify use-case: It is not for end-users, it is for agents only.

Open
#4 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Swift
Stars
7
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Currently README says:
> A lightweight iOS SDK built with Swift and UIKit to embed a Chatwoot-powered chat interface in any iOS app.

And it makes people think that this SDK can be used to present built-in chat UIs for their end-users in their apps, so they can communicate with the customer support.

It does not indicate anything about this is only for agents, not end users.

Following a simple web search that ends up on this repo, people won't be able to easily differentiate this just by the repo name, unless they go through your full glossary.

Please update README to prevent further confusion. And also add a link to actual native iOS SDK for end-user chat if you have one, or state that there is none.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open README and review the current description of the iOS SDK. Clarify that it is intended for agents rather than end-user chat, then check whether Chatwoot has a native iOS SDK for end users and add its link or state that none exists. Done means a reader can distinguish this repository's use case without consulting the glossary.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.