add gif example and DocC site

.github/workflows/master_workflow.yml

@@ -0,0 +1,57 @@
+name: master_workflow
+
+on:
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.runsOn }}
+    env:
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}/Contents/Developer"
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+
+    - name: Build On ${{ matrix.name }}
+      continue-on-error: false
+      run: |
+        xcodebuild -scheme DarkRoom -destination '${{ matrix.destination }}' build
+    
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - destination: 'platform=iOS Simulator,name=iPhone 13'
+            runsOn: macos-12
+            xcode: "Xcode_13.4.1.app"
+            name: "iPhone 13, iOS Latest, Xcode 13.4.1"
+
+  build-docc:
+    needs: build
+    runs-on: macos-12
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+      with:
+       repository: ${{ github.event.pull_request.head.repo.full_name }}
+       ref: ${{ github.event.pull_request.head.ref }}
+
+    - name: build static site
+      uses: kiarashvosough1999/[email protected]
+
+  deploy-docc-to-github-pages:
+    needs: build-docc
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      contents: read
+      id-token: write
+    steps:
+    - name: deploy static site
+      uses: kiarashvosough1999/[email protected]

.github/workflows/shared_workflow.yml

@@ -2,11 +2,11 @@ name: shared_workflow
 
 on:
   push:
-    branches:
-      - '**'
+    branches-ignore:
+      - master
   pull_request:
-    branches:
-      - '**'
+    branches-ignore:
+      - master
 
 jobs:
   build:

README.md

@@ -25,7 +25,7 @@ Elegant Media Viewer Written In Swift.
 - [x] Play Video With Custom Control Configuration.
 - [x] Support Custom Configuration For Almost Each Component.
 - [x] Support HLS And Local Videos.
-- [x] Documented By DocC.
+- [x] Documented By DocC **[Link To Documents](https://divar-ir.github.io/DarkRoom/documentation/darkroom)**.
 - [ ] Support `AVAssetResourceLoaderDelegate`.
 - [ ] Support `CocoaPods`(soon)
 - [ ] Support `Carthage`
@@ -55,6 +55,9 @@ dependencies: [
 
 We have provided one sample project in the repository. To use it clone the repo, Source files for these are in the `iOS-Example` directory in project navigator. Have fun!
 
+![ex](https://github.com/divar-ir/DarkRoom/blob/master/resources/example1.gif)
+![ex](https://github.com/divar-ir/DarkRoom/blob/master/resources/example2.gif)
+
 ## Usage
 
 The Main Component is ``DarkRoomCarouselViewController`` which you can use and provide it with datasource to show images or play videos.