Skip to content

Commit 0d86e70

Browse files
Merge pull request #370 from OneSignal/feature/packageDocumentation
Updated documentation for packages
2 parents 0566677 + c0b682d commit 0d86e70

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+452
-55
lines changed

Documentation/asset_listing.png

69.7 KB
Loading

Documentation/menu_import_package.png

15.8 KB
Loading

Documentation/menu_import_package.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Documentation/menu_my_assets.png

8.8 KB
Loading

Documentation/menu_my_assets.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
6.92 KB
Loading

Documentation/menu_package_manager.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Documentation/outdated_callout.png

8.78 KB
Loading

Documentation/package_import.png

32.1 KB
Loading

Documentation/package_manager_tab.png

58.4 KB
Loading

Documentation/package_manager_tab.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Documentation/registry_menu.png

11.4 KB
Loading

Documentation/registry_menu.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Documentation/setup_window.png

22.7 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
### Added
9+
- A new Editor window under **Window > OneSignal** can be found which currently includes additional setup steps for installation.
10+
11+
### Changed
12+
- The OneSignal Unity SDK has now transitioned to [Unity Package Manager](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) support
13+
- If you are updating from a previous version of the OneSignal Unity SDK please follow the Unity Asset Store instructions in
14+
the [README](https://github.com/OneSignal/OneSignal-Unity-SDK/README.md#unity-asset-store) to ensure a smooth transition.
15+
16+
[Unreleased]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/v2.13.6...HEAD

OneSignalExample/Assets/OneSignal/CHANGELOG.md.meta

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading
Loading

OneSignalExample/Assets/OneSignal/Documentation~/menu_import_package.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

OneSignalExample/Assets/OneSignal/Documentation~/menu_my_assets.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

OneSignalExample/Assets/OneSignal/Documentation~/menu_package_manager.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading
Loading
Loading

OneSignalExample/Assets/OneSignal/Documentation~/package_manager_tab.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

OneSignalExample/Assets/OneSignal/Documentation~/registry_menu.png.meta

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

OneSignalExample/Assets/OneSignal/Editor/Resources/OneSignalFileInventory.asset

+16-5
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,38 @@ MonoBehaviour:
1313
m_Name: OneSignalFileInventory
1414
m_EditorClassIdentifier:
1515
DistributedPaths:
16-
- Assets/OneSignal/.DS_Store
1716
- Assets/OneSignal/CHANGELOG.md
1817
- Assets/OneSignal/CHANGELOG.md.meta
1918
- Assets/OneSignal/Editor.meta
2019
- Assets/OneSignal/Example.meta
20+
- Assets/OneSignal/LICENSE.md
21+
- Assets/OneSignal/LICENSE.md.meta
2122
- Assets/OneSignal/OneSignal.UnityPackage.asmdef
2223
- Assets/OneSignal/OneSignal.UnityPackage.asmdef.meta
2324
- Assets/OneSignal/README.md
2425
- Assets/OneSignal/README.md.meta
2526
- Assets/OneSignal/VERSION
2627
- Assets/OneSignal/VERSION.meta
27-
- Assets/OneSignal/Editor/.DS_Store
28+
- Assets/OneSignal/Documentation~/asset_listing.png
29+
- Assets/OneSignal/Documentation~/menu_import_package.png
30+
- Assets/OneSignal/Documentation~/menu_import_package.png.meta
31+
- Assets/OneSignal/Documentation~/menu_my_assets.png
32+
- Assets/OneSignal/Documentation~/menu_my_assets.png.meta
33+
- Assets/OneSignal/Documentation~/menu_package_manager.png
34+
- Assets/OneSignal/Documentation~/menu_package_manager.png.meta
35+
- Assets/OneSignal/Documentation~/outdated_callout.png
36+
- Assets/OneSignal/Documentation~/package_import.png
37+
- Assets/OneSignal/Documentation~/package_manager_tab.png
38+
- Assets/OneSignal/Documentation~/package_manager_tab.png.meta
39+
- Assets/OneSignal/Documentation~/registry_menu.png
40+
- Assets/OneSignal/Documentation~/registry_menu.png.meta
41+
- Assets/OneSignal/Documentation~/setup_window.png
2842
- Assets/OneSignal/Editor/AssemblyInfo.cs
2943
- Assets/OneSignal/Editor/AssemblyInfo.cs.meta
3044
- Assets/OneSignal/Editor/OneSignalBootstrapper.cs
3145
- Assets/OneSignal/Editor/OneSignalBootstrapper.cs.meta
3246
- Assets/OneSignal/Editor/OneSignalFileInventory.cs
3347
- Assets/OneSignal/Editor/OneSignalFileInventory.cs.meta
34-
- Assets/OneSignal/Editor/OneSignalRegistries.xml
35-
- Assets/OneSignal/Editor/OneSignalRegistries.xml.meta
3648
- Assets/OneSignal/Editor/PackageManagement.meta
3749
- Assets/OneSignal/Editor/Resources.meta
3850
- Assets/OneSignal/Editor/Setup.meta
@@ -60,7 +72,6 @@ MonoBehaviour:
6072
- Assets/OneSignal/Editor/Utilities/GitHubUtility.cs.meta
6173
- Assets/OneSignal/Editor/Utilities/MiniJSON.cs
6274
- Assets/OneSignal/Editor/Utilities/MiniJSON.cs.meta
63-
- Assets/OneSignal/Example/.DS_Store
6475
- Assets/OneSignal/Example/Scenes.meta
6576
- Assets/OneSignal/Example/Scripts.meta
6677
- Assets/OneSignal/Example/Scenes/OneSignalExampleScene.unity
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
Modified MIT License
2+
3+
Copyright 2020 OneSignal
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
1. The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
2. All copies of substantial portions of the Software may only be used in connection
16+
with services provided by OneSignal.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24+
THE SOFTWARE.
25+
26+
27+
Includes portions from the Google GcmClient demo project:
28+
Copyright 2013 Google Inc.
29+
30+
Licensed under the Apache License, Version 2.0 (the "License");
31+
you may not use this file except in compliance with the License.
32+
You may obtain a copy of the License at
33+
34+
http://www.apache.org/licenses/LICENSE-2.0
35+
36+
Unless required by applicable law or agreed to in writing, software
37+
distributed under the License is distributed on an "AS IS" BASIS,
38+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
39+
See the License for the specific language governing permissions and
40+
limitations under the License.
41+
42+
Includes portions from RootTools:
43+
Copyright (c) 2012 Stephen Erickson, Chris Ravenscroft, Dominik Schuermann, Adam Shanks
44+
45+
This code is dual-licensed under the terms of the Apache License Version 2.0 and
46+
the terms of the General Public License (GPL) Version 2.
47+
You may use this code according to either of these licenses as is most appropriate
48+
for your project on a case-by-case basis.
49+
50+
The terms of each license can be found at:
51+
52+
* http://www.apache.org/licenses/LICENSE-2.0
53+
* http://www.gnu.org/licenses/gpl-2.0.txt
54+
55+
Unless required by applicable law or agreed to in writing, software
56+
distributed under these Licenses is distributed on an "AS IS" BASIS,
57+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
58+
See each License for the specific language governing permissions and
59+
limitations under that License.
60+
61+
Includes portions from DTTJailbreakDetection:
62+
The MIT License (MIT)
63+
64+
Copyright (c) 2014 Doan Truong Thi
65+
66+
Permission is hereby granted, free of charge, to any person obtaining a copy of
67+
this software and associated documentation files (the "Software"), to deal in
68+
the Software without restriction, including without limitation the rights to
69+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
70+
the Software, and to permit persons to whom the Software is furnished to do so,
71+
subject to the following conditions:
72+
73+
The above copyright notice and this permission notice shall be included in all
74+
copies or substantial portions of the Software.
75+
76+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
77+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
78+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
79+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
80+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
81+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
82+
83+
Includes portions from BSMobileProvision:
84+
Copyright (c) 2013, The Blindsight Corporation
85+
All rights reserved.
86+
87+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
88+
89+
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
90+
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
91+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
92+
93+
Includes ShortcutBadger:
94+
Unless required by applicable law or agreed to in writing, software
95+
distributed under these Licenses is distributed on an "AS IS" BASIS,
96+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
97+
See each License for the specific language governing permissions and
98+
limitations under that License.
99+
100+
101+
Copyright 2014 Leo Lin
102+
103+
Licensed under the Apache License, Version 2.0 (the "License");
104+
you may not use this file except in compliance with the License.
105+
You may obtain a copy of the License at
106+
107+
http://www.apache.org/licenses/LICENSE-2.0
108+
109+
Unless required by applicable law or agreed to in writing, software
110+
distributed under the License is distributed on an "AS IS" BASIS,
111+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
112+
See the License for the specific language governing permissions and
113+
limitations under the License.
114+
115+
116+
Includes unity-jar-resolver
117+
Copyright (C) 2014 Google Inc.
118+
119+
Licensed under the Apache License, Version 2.0 (the "License");
120+
you may not use this file except in compliance with the License.
121+
You may obtain a copy of the License at
122+
123+
http://www.apache.org/licenses/LICENSE-2.0
124+
125+
Unless required by applicable law or agreed to in writing, software
126+
distributed under the License is distributed on an "AS IS" BASIS,
127+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
128+
See the License for the specific language governing permissions and
129+
limitations under the License.

OneSignalExample/Assets/OneSignal/LICENSE.md.meta

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)