Skip to content

Commit 8ac7a3e

Browse files
authored
Merge pull request #1 from ysskrishna/feature/basic-functions
Add Basic functions API
2 parents 846072a + b28d883 commit 8ac7a3e

File tree

19 files changed

+975
-159
lines changed

19 files changed

+975
-159
lines changed

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.3.0]
9+
10+
### Added
11+
12+
- Module-level convenience functions for simplified API usage:
13+
- `detect_platform(url)` - Detect platform from URL without instantiating SocialLinks
14+
- `is_valid(platform_name, url)` - Validate URL for a specific platform
15+
- `sanitize(platform_name, url)` - Sanitize URL to canonical format
16+
- `list_platforms()` - List all supported platform names
17+
- Separate documentation pages for better organization:
18+
- `basic-api.md` - Documentation for module-level convenience functions
19+
- `core-api.md` - Documentation for SocialLinks class and advanced features
20+
- `constants.md` - Documentation for constants and type aliases
21+
- `exceptions.md` - Documentation for exception hierarchy
22+
- Add test cases for module-level functions.
23+
24+
### Changed
25+
26+
- Enhanced README with improved Quick Start section using module functions
27+
- Added comprehensive "Basic Usage" section with extensive examples
28+
- Improved README organization with clearer separation between basic and advanced usage
29+
830
## [1.2.1]
931

1032
### Added
@@ -137,6 +159,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
137159
- Automatic @ symbol handling
138160
- URL normalization and sanitization
139161

162+
[1.3.0]: https://github.com/ysskrishna/social-links/compare/v1.2.1...v1.3.0
140163
[1.2.1]: https://github.com/ysskrishna/social-links/compare/v1.2.0...v1.2.1
141164
[1.2.0]: https://github.com/ysskrishna/social-links/compare/v1.1.0...v1.2.0
142165
[1.1.0]: https://github.com/ysskrishna/social-links/compare/v1.0.0...v1.1.0

0 commit comments

Comments
 (0)