docs: update README with usage example and dev guide#1
docs: update README with usage example and dev guide#10x3EF8 wants to merge 1 commit intohallofcodes:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances the project's documentation by significantly expanding the README with practical usage examples, detailed development setup instructions, and contribution guidelines. The update transforms a minimal README into comprehensive documentation that will help both users and contributors get started with the fca-redux library.
- Added a complete Quick Start section with a working TypeScript example showing login and message listening
- Expanded development setup with step-by-step instructions for build, lint, format, and test commands
- Introduced Contributing section with clear guidelines for submitting pull requests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Developer Experience**: | ||
| - Full TypeScript support with type definitions. | ||
| - Integrated debugging and logging utilities. | ||
| - customizable options (User Agent, auto-reconnect, etc.). |
There was a problem hiding this comment.
Inconsistent capitalization in the sentence. The word "customizable" should be capitalized to match the style of other bullet points in this list, which all start with capital letters.
| - customizable options (User Agent, auto-reconnect, etc.). | |
| - Customizable options (User Agent, auto-reconnect, etc.). |
|
|
||
| To set up the project locally for development: | ||
|
|
||
| 1. **Install dependencies:** |
There was a problem hiding this comment.
Inconsistent spacing in numbered list. All other numbered list items in the "Contributing" section use a period followed by two spaces before the text (e.g., "1. Fork"), but this formatting should be consistent throughout both the "Development" and "Contributing" sections.
|
|
||
| // Your 'appState.json' contains the cookies from a logged-in session. | ||
| const credentials = { | ||
| appState: require('./appState.json') |
There was a problem hiding this comment.
The code example uses require() for importing JSON, which is CommonJS syntax, while the rest of the example uses ES6 import syntax. This creates a mixing of module systems that may not work in all TypeScript configurations. Consider showing both approaches or using a more TypeScript-friendly approach like importing from a variable or using dynamic import.
| // Your 'appState.json' contains the cookies from a logged-in session. | |
| const credentials = { | |
| appState: require('./appState.json') | |
| import appState from './appState.json'; | |
| // Your 'appState.json' contains the cookies from a logged-in session. | |
| const credentials = { | |
| appState |
No description provided.