Skip to content

Commit b7c063a

Browse files
Update README and other complementary files
1 parent a0aa547 commit b7c063a

File tree

4 files changed

+22
-10
lines changed

4 files changed

+22
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Checkout code
1717
uses: actions/checkout@v4
1818

19-
- name: Set up nodejs
19+
- name: Set up Node.js
2020
uses: actions/setup-node@v4
2121
with:
2222
node-version: '20'

CONTRIBUTORS-GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to the Split angular plugin
1+
# Contributing to the Split Angular plugin
22

33
Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
44

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22

3-
Copyright © 2024 Split Software, Inc.
3+
Copyright © 2025 Split Software, Inc.
44

55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1-
# angular-sdk-plugin
1+
# Split Angular plugin
2+
3+
[![npm version](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-angular.svg)](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-angular) [![Build Status](https://github.com/splitio/angular-sdk-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/splitio/angular-sdk-plugin/actions/workflows/ci.yml)
4+
25
This repository contains utilities for the Angular framework, that integrates with Split JS SDK and offers an integrated experience with the Angular framework
36

47
## Overview
5-
This utilities are designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
8+
9+
These utilities are designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
610

711
[![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
812

913
## Compatibility
14+
1015
This SDK is compatible with Angular 18.2.0 and above.
1116

1217
## Getting started
18+
1319
Below is a simple example that describes the instantiation and most basic usage of our SDK:
1420
```javascript
1521
// Import the Service
@@ -49,9 +55,11 @@ export class AppComponent implements OnInit {
4955
The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/angular-sdk-plugin/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
5056

5157
## Contributing
52-
Please see <Link to contributors guide> to find all you need to submit a Pull Request (PR).
58+
59+
Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
5360

5461
## License
62+
5563
Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
5664

5765
## About Split
@@ -64,13 +72,17 @@ Split has built and maintains SDKs for:
6472

6573
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
6674
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
75+
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
76+
* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://help.split.io/hc/en-us/articles/26988707417869-Elixir-Thin-Client-SDK)
77+
* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
6778
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
6879
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
6980
* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
70-
* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
71-
* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
72-
* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
81+
* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
82+
* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
83+
* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
7384
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
85+
* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)
7486
* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
7587
* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
7688
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
@@ -81,4 +93,4 @@ For a comprehensive list of open source projects visit our [Github page](https:/
8193

8294
**Learn more about Split:**
8395

84-
Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.
96+
Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](https://help.split.io) for more detailed information.

0 commit comments

Comments
 (0)