README

mx-space · Jul 16, 2023 · fa8e01d · fa8e01d
1 parent 499dc84
commit fa8e01d
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 13 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Innei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/ProcessReporter.xcodeproj/project.pbxproj b/ProcessReporter.xcodeproj/project.pbxproj
@@ -12,9 +12,9 @@
 		1F04C2242A63CB7B002FE62F /* ReportTypeView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F04C2232A63CB7B002FE62F /* ReportTypeView.swift */; };
 		1F04C2262A63CBED002FE62F /* ReportInfoView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F04C2252A63CBED002FE62F /* ReportInfoView.swift */; };
 		1F04C2282A63D4B9002FE62F /* BaseSettingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F04C2272A63D4B9002FE62F /* BaseSettingView.swift */; };
+		1F04C22C2A63E5A2002FE62F /* LaunchAtLogin in Frameworks */ = {isa = PBXBuildFile; productRef = 1F04C22B2A63E5A2002FE62F /* LaunchAtLogin */; };
 		1F1E981B2A511E3F006A7D39 /* nowplaying.mm in Sources */ = {isa = PBXBuildFile; fileRef = 1F1E981A2A511E3F006A7D39 /* nowplaying.mm */; };
 		1F3BE35F2A62F13D0059A818 /* Agent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F3BE35E2A62F13D0059A818 /* Agent.swift */; };
-		1F3BE3652A62F8C30059A818 /* LaunchAtLogin in Frameworks */ = {isa = PBXBuildFile; productRef = 1F3BE3642A62F8C30059A818 /* LaunchAtLogin */; };
 		1F3BE3672A62FA910059A818 /* ReportType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F3BE3662A62FA910059A818 /* ReportType.swift */; };
 		1F3BE3692A62FB220059A818 /* Persisted+Modifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F3BE3682A62FB220059A818 /* Persisted+Modifier.swift */; };
 		1F3BE36B2A62FED80059A818 /* Array+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F3BE36A2A62FED80059A818 /* Array+Extension.swift */; };
@@ -34,6 +34,7 @@
 		1F04C2232A63CB7B002FE62F /* ReportTypeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReportTypeView.swift; sourceTree = "<group>"; };
 		1F04C2252A63CBED002FE62F /* ReportInfoView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReportInfoView.swift; sourceTree = "<group>"; };
 		1F04C2272A63D4B9002FE62F /* BaseSettingView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BaseSettingView.swift; sourceTree = "<group>"; };
+		1F04C2292A63E391002FE62F /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 		1F1E98192A511E3F006A7D39 /* ProcessReporter-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "ProcessReporter-Bridging-Header.h"; sourceTree = "<group>"; };
 		1F1E981A2A511E3F006A7D39 /* nowplaying.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = nowplaying.mm; sourceTree = "<group>"; };
 		1F1E981C2A511E7C006A7D39 /* Enums.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Enums.h; sourceTree = "<group>"; };
@@ -61,8 +62,8 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				1F04C22C2A63E5A2002FE62F /* LaunchAtLogin in Frameworks */,
 				1F04C2222A63C81B002FE62F /* SwiftJotai in Frameworks */,
-				1F3BE3652A62F8C30059A818 /* LaunchAtLogin in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -95,6 +96,7 @@
 		1F6FE2BC2A468DFB00D646CE = {
 			isa = PBXGroup;
 			children = (
+				1F04C2292A63E391002FE62F /* README.md */,
 				1F6FE2C72A468DFB00D646CE /* ProcessReporter */,
 				1F6FE2C62A468DFB00D646CE /* Products */,
 			);
@@ -156,8 +158,8 @@
 			);
 			name = ProcessReporter;
 			packageProductDependencies = (
-				1F3BE3642A62F8C30059A818 /* LaunchAtLogin */,
 				1F04C2212A63C81B002FE62F /* SwiftJotai */,
+				1F04C22B2A63E5A2002FE62F /* LaunchAtLogin */,
 			);
 			productName = ProcessReporter;
 			productReference = 1F6FE2C52A468DFB00D646CE /* ProcessReporter.app */;
@@ -189,8 +191,8 @@
 			);
 			mainGroup = 1F6FE2BC2A468DFB00D646CE;
 			packageReferences = (
-				1F3BE3632A62F8C30059A818 /* XCRemoteSwiftPackageReference "LaunchAtLogin" */,
 				1F04C2202A63C81B002FE62F /* XCRemoteSwiftPackageReference "SwiftJotai" */,
+				1F04C22A2A63E5A2002FE62F /* XCRemoteSwiftPackageReference "LaunchAtLogin-Modern" */,
 			);
 			productRefGroup = 1F6FE2C62A468DFB00D646CE /* Products */;
 			projectDirPath = "";
@@ -374,7 +376,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 13.0;
-				MARKETING_VERSION = 1.1;
+				MARKETING_VERSION = 1.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = dev.innei.ProcessReporter;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
@@ -405,7 +407,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 13.0;
-				MARKETING_VERSION = 1.1;
+				MARKETING_VERSION = 1.2.0;
 				PRODUCT_BUNDLE_IDENTIFIER = dev.innei.ProcessReporter;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
@@ -446,9 +448,9 @@
 				kind = branch;
 			};
 		};
-		1F3BE3632A62F8C30059A818 /* XCRemoteSwiftPackageReference "LaunchAtLogin" */ = {
+		1F04C22A2A63E5A2002FE62F /* XCRemoteSwiftPackageReference "LaunchAtLogin-Modern" */ = {
 			isa = XCRemoteSwiftPackageReference;
-			repositoryURL = "https://github.com/sindresorhus/LaunchAtLogin";
+			repositoryURL = "https://github.com/sindresorhus/LaunchAtLogin-Modern";
 			requirement = {
 				branch = main;
 				kind = branch;
@@ -462,9 +464,9 @@
 			package = 1F04C2202A63C81B002FE62F /* XCRemoteSwiftPackageReference "SwiftJotai" */;
 			productName = SwiftJotai;
 		};
-		1F3BE3642A62F8C30059A818 /* LaunchAtLogin */ = {
+		1F04C22B2A63E5A2002FE62F /* LaunchAtLogin */ = {
 			isa = XCSwiftPackageProductDependency;
-			package = 1F3BE3632A62F8C30059A818 /* XCRemoteSwiftPackageReference "LaunchAtLogin" */;
+			package = 1F04C22A2A63E5A2002FE62F /* XCRemoteSwiftPackageReference "LaunchAtLogin-Modern" */;
 			productName = LaunchAtLogin;
 		};
 /* End XCSwiftPackageProductDependency section */

diff --git a/ProcessReporter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/ProcessReporter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -1,12 +1,12 @@
 {
   "pins" : [
     {
-      "identity" : "launchatlogin",
+      "identity" : "launchatlogin-modern",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/sindresorhus/LaunchAtLogin",
+      "location" : "https://github.com/sindresorhus/LaunchAtLogin-Modern",
       "state" : {
         "branch" : "main",
-        "revision" : "7ad6331f9c38953eb1ce8737758e18f7607e984a"
+        "revision" : "9c41991631605c8ccfe0347bbcb5c659169f2ec5"
       }
     },
     {

diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+#  Process Reporter
+
+Process Reporter for [Shiro](https://github.com/Innei/Shiro) is a macOS application built with Swift UI. It is designed to report in real time the name of the foreground application being used by the current user on macOS, as well as any media information being played.
+
+## Main Features
+
+- Real-time reporting of the foreground application being used by the current user
+- Real-time reporting of any media information being played by the current user
+
+This data is reported to our server, which then notifies users browsing the Shiro-built website in real time via WebSocket. This allows users to see their real-time activity on the website.
+
+## How to Use
+
+1. Clone this repository to your local machine.
+2. Open the project in Xcode and compile it.
+3. Open the compiled app and go to settings. Fill in your apiKey and api endpoint url.
+4. Start using your macOS device, and Process Reporter for Shiro will automatically report your activity.
+
+## Dependencies
+
+This project uses the following open-source libraries:
+
+- [SwiftJotai](https://github.com/unixzii/SwiftJotai)
+- [LaunchAtLogin-Modern](https://github.com/sindresorhus/LaunchAtLogin-Modern)
+- [nowplaying-cli](https://github.com/kirtan-shah/nowplaying-cli)
+
+
+## Open Source and Contribution
+
+Process Reporter for Shiro is an open-source project, and we welcome contributions from anyone. If you have any issues or suggestions, feel free to submit an issue or pull request.
+
+## License
+
+Process Reporter for Shiro is licensed under the MIT License. For details, please see the LICENSE file.