IOS-2025 :: MJ Harmony :: Feature Internal :: Improve README in Harmony-Swift (mobilejazz#49)

Author: jfilowk

README.md

@@ -19,10 +19,12 @@
   </p>
 
   <p align="center">
-    <a href="https://travis-ci.org/mobilejazz/harmony-ios"><img alt="CI Status" src="http://img.shields.io/travis/mobilejazz/harmony-ios.svg?style=flat)"></a>
-    <a href="http://cocoapods.org/pods/Harmony"><img alt="Version" src="https://img.shields.io/cocoapods/v/Harmony.svg?style=flat"></a>
-    <a href="http://cocoapods.org/pods/Harmony"><img alt="License" src="https://img.shields.io/cocoapods/l/Harmony.svg?style=flat"></a>
-    <a href="http://cocoapods.org/pods/Harmony"><img alt="Platform" src="https://img.shields.io/cocoapods/p/Harmony.svg?style=flat"></a>
+    <a href="https://img.shields.io/badge/Platforms-macOS_iOS-yellowgreen?style=flat-square"><img alt="Supported platforms" src="https://img.shields.io/badge/Platforms-macOS_iOS-yellowgreen?style=flat-square"></a>
+    <a href="https://img.shields.io/cocoapods/v/Harmony.svg"><img alt="Harmony Cocoapods" src="https://cocoapods.org/pods/Harmony"></a>
+    <a href="https://github.com/Carthage/Carthage"><img alt="Carthage Compatible" src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat-square"></a>
+    <a href="https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square"><img alt="SPM Compatible" src="https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square"></a>
+    <a href="https://twitter.com/mobilejazzcom"><img alt="Mobile Jazz twitter" src="https://img.shields.io/badge/[email protected]?style=flat-square"></a>
+    <a href="https://github.com/mobilejazz/harmony-swift/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/mobilejazz/harmony-swift"></a>
   </p>
 </p>
 
@@ -40,7 +42,9 @@ it, simply add the following line to your Podfile:
 ```ruby
 pod 'Harmony', '~> 2.0.2'
 ```
+
 For unit test, you can use the following pod:
+
 ```ruby
 pod 'HarmonyTesting', '~> 2.0.2'
 ```
@@ -60,6 +64,7 @@ dependencies: [
     .package(url: "https://github.com/mobilejazz/harmony-swift", .upToNextMajor(from: "2.0.2"))
 ]
 ```
+
 This package includes two libraries: `Harmony` and `HarmonyTesting`.
 
 ## Development
@@ -70,11 +75,21 @@ First of all, run to resolve the dependencies.
 carthage update --use-xcframeworks --platform [iOS|macOS] --no-use-binaries
 ```
 
+The development of the library is done using Carthage. For this, we use the .xcodeproj. Including the unit tests.
+
+If we want to use the Example for Harmony development, open Example/Harmony.xcworkspace. Example uses Cocoapods to resolve the dependency on Harmony. Any new dependencies must be added in the Harmony **.podsec**. This way it will be available for both development and distribution of the library. Later, we must add the dependencies in Carthage and SPM as well.
+
+Any dependencies used for Example development, for example Kingfisher for downloading images, must be added in the Podfile and not in the .podspec.
+
+#### Important!
+
+All the new dependencies must be added in all the package managers we support (Carthage, Cocoapods and SPM).
+
 ## Author
 
 Mobile Jazz, [email protected]
 
-## API Reference 
+## API Reference
 
 [https://harmony.mobilejazz.com/docs/introduction](https://harmony.mobilejazz.com/docs/introduction)