Skip to content

Commit e3d0e84

Browse files
committed
chore: add readme badges
1 parent 793ef0c commit e3d0e84

6 files changed

Lines changed: 115 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing to Replane JavaScript SDKs
2+
3+
Thank you for your interest in contributing! This guide will help you get started.
4+
5+
## Getting Started
6+
7+
### Prerequisites
8+
9+
- **Node.js**: Version 18.0.0 or greater
10+
- **pnpm**: Version 10.25.0 or greater (check with `pnpm --version`)
11+
12+
### Clone the Repository
13+
14+
```sh
15+
git clone https://github.com/replane-dev/replane-javascript.git
16+
cd replane-javascript
17+
```
18+
19+
### Install Dependencies
20+
21+
```sh
22+
pnpm install
23+
```
24+
25+
## Development
26+
27+
This is a monorepo managed with [pnpm workspaces](https://pnpm.io/workspaces). The packages are located in the `packages/` directory:
28+
29+
- `packages/sdk` - Core SDK for Node.js, Deno, Bun, and browsers
30+
- `packages/react` - React bindings with hooks and context
31+
- `packages/next` - Next.js SDK with SSR/SSG support
32+
- `packages/svelte` - Svelte bindings with stores
33+
34+
### Build All Packages
35+
36+
```sh
37+
pnpm build
38+
```
39+
40+
### Run Tests
41+
42+
```sh
43+
pnpm test
44+
```
45+
46+
### Type Check
47+
48+
```sh
49+
pnpm typecheck
50+
```
51+
52+
### Lint
53+
54+
```sh
55+
pnpm lint
56+
57+
# Auto-fix lint issues
58+
pnpm lint:fix
59+
```
60+
61+
### Format
62+
63+
```sh
64+
pnpm format
65+
66+
# Check formatting
67+
pnpm format:check
68+
```
69+
70+
## Pull Requests
71+
72+
1. Fork the repository
73+
2. Create a feature branch: `git checkout -b feature/your-feature`
74+
3. Make your changes
75+
4. Ensure tests pass: `pnpm test`
76+
5. Ensure linting passes: `pnpm lint`
77+
6. Ensure type checking passes: `pnpm typecheck`
78+
7. Commit your changes with a descriptive message
79+
8. Push to your fork and submit a pull request
80+
81+
## Reporting Issues
82+
83+
Found a bug or have a feature request? Please open an issue on GitHub.
84+
85+
## Community
86+
87+
Have questions or want to discuss Replane? Join the conversation in [GitHub Discussions](https://github.com/orgs/replane-dev/discussions).
88+
89+
## License
90+
91+
By contributing to Replane JavaScript SDKs, you agree that your contributions will be licensed under the MIT License.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Official JavaScript/TypeScript SDKs for [Replane](https://github.com/replane-dev/replane) — feature flags and remote configuration with realtime updates.
44

5+
[![CI](https://github.com/replane-dev/replane-javascript/actions/workflows/ci.yml/badge.svg)](https://github.com/replane-dev/replane-javascript/actions)
6+
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
7+
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
8+
59
## Packages
610

711
| Package | Description | npm |
@@ -170,6 +174,10 @@ pnpm test
170174
pnpm typecheck
171175
```
172176

177+
## Contributing
178+
179+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.
180+
173181
## Community
174182

175183
Have questions or want to discuss Replane? Join the conversation in [GitHub Discussions](https://github.com/orgs/replane-dev/discussions).

packages/next/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# @replanejs/next
22

3+
[![npm](https://img.shields.io/npm/v/@replanejs/next)](https://www.npmjs.com/package/@replanejs/next)
4+
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
5+
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
6+
37
Next.js SDK for Replane - feature flags and remote configuration with SSR support.
48

59
## Installation

packages/react/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# @replanejs/react
22

3+
[![npm](https://img.shields.io/npm/v/@replanejs/react)](https://www.npmjs.com/package/@replanejs/react)
4+
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
5+
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
6+
37
React SDK for [Replane](https://github.com/replane-dev/replane-javascript) - feature flags and remote configuration.
48

59
## Installation

packages/sdk/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Replane JavaScript SDK
22

3+
[![npm](https://img.shields.io/npm/v/@replanejs/sdk)](https://www.npmjs.com/package/@replanejs/sdk)
4+
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
5+
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
6+
37
Small TypeScript client for watching configuration values from a Replane API with realtime updates and context-based override evaluation.
48

59
Part of the Replane project: [replane-dev/replane](https://github.com/replane-dev/replane).

packages/svelte/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# @replanejs/svelte
22

3+
[![npm](https://img.shields.io/npm/v/@replanejs/svelte)](https://www.npmjs.com/package/@replanejs/svelte)
4+
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
5+
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
6+
37
Svelte SDK for [Replane](https://github.com/replane-dev/replane-javascript) - feature flags and remote configuration with reactive stores.
48

59
## Installation

0 commit comments

Comments
 (0)