From 815703b177df320eeca714b26255343969674bcf Mon Sep 17 00:00:00 2001 From: Daniel Brendel Date: Sun, 25 Sep 2022 10:26:49 +0200 Subject: [PATCH] Naming --- app/views/index.php | 90 ++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 45 deletions(-) diff --git a/app/views/index.php b/app/views/index.php index d7cb786..e30b851 100644 --- a/app/views/index.php +++ b/app/views/index.php @@ -10,12 +10,12 @@

About

- SteamCards is a clientside web component that offers an easy way to integrate Steam Cards of various Steam - entities into your website. Therefore you only need very few code in order to render Steam Cards into your document. + {{ env('APP_NAME') }} is a clientside web component that offers an easy way to integrate Steam Widgets of various Steam + entities into your website. Therefore you only need very few code in order to render Steam Widgets into your document.

- SteamCards is used via JavaScript. Since JavaScript is supported by all major browser per default it is + {{ env('APP_NAME') }} is used via JavaScript. Since JavaScript is supported by all major browser per default it is platform independent and compatible.

@@ -30,17 +30,17 @@

- You can use SteamCards by referencing the neccessary JavaScript files from the official SteamCards server as follows:
+ You can use {{ env('APP_NAME') }} by referencing the neccessary JavaScript files from the official {{ env('APP_NAME') }} server as follows:

 			
-<script src="{{ url('/api/resource/query?type=js&module=STEAM_CARDS_MODULE&version=v1') }}"></script>
+<script src="{{ url('/api/resource/query?type=js&module=STEAM_WIDGETS_MODULE&version=v1') }}"></script>

- STEAM_CARDS_MODULE can either be app for the Steam App widget, server for the Steam Server widget or + STEAM_WIDGETS_MODULE can either be app for the Steam App widget, server for the Steam Server widget or user for the Steam User widget.

@@ -61,7 +61,7 @@

Steam App

- When referenced the required Steam App module, the minimum code to render a card is as follows:
+ When referenced the required Steam App module, the minimum code to render a widget is as follows:

 			
 <steam-app appid="620"></steam-app>
@@ -69,7 +69,7 @@


- This renders the following card:
+ This renders the following widget:

@@ -119,12 +119,12 @@ width - Specify the width of the card + Specify the width of the widget height - Specify the height of the card + Specify the height of the widget @@ -164,22 +164,22 @@ style-hideimage / style.hideimage - Specify whether the card image shall be hidden or not + Specify whether the widget image shall be hidden or not

- You can also dynamically create Steam App cards via JavaScript:
+ You can also dynamically create Steam App widgets via JavaScript:

 			
-<div id="app-card"></div>
+<div id="app-widget"></div>
 
 <script>
 document.addEventListener('DOMContentLoaded', function() {
-    let card = new SteamApp('#app-card', {
+    let widget = new SteamApp('#app-widget', {
         appid: '620',
         //You can specify the same attributes as shown in the table above
     });
@@ -204,23 +204,23 @@ document.addEventListener('DOMContentLoaded', function() {
 				
 
 				
-					updateCard()
-					Updates the card data and displays them
+					updateWidget()
+					Updates the widget data and displays them
 				
 
 				
 					changeLang(lang, playtext, author, onlinecount)
-					Changes the language of the card using the given information
+					Changes the language of the widget using the given information
 				
 
 				
 					setImageVisibility(visibility)
-					Sets the card image visibility
+					Sets the widget image visibility
 				
 
 				
 					remove()
-					Removes the card from the document
+					Removes the widget from the document
 				
 			
 		
@@ -235,7 +235,7 @@ document.addEventListener('DOMContentLoaded', function() {
 	
Steam Server

 
 	

-		When referenced the required Steam Server module, the minimum code to render a card is as follows:

+		When referenced the required Steam Server module, the minimum code to render a widget is as follows:

 		
 			
 <steam-server addr="ip:port"></steam-server>
@@ -243,7 +243,7 @@ document.addEventListener('DOMContentLoaded', function() {
 		

 
 		


-		This renders the following card:

+		This renders the following widget:

 		
 	

 
@@ -268,7 +268,7 @@ document.addEventListener('DOMContentLoaded', function() {
 
 				
 					header
-					If you want to render the card with a header image you may specify the URL to an image here
+					If you want to render the widget with a header image you may specify the URL to an image here
 				
 
 				
@@ -303,12 +303,12 @@ document.addEventListener('DOMContentLoaded', function() {
 
 				
 					width
-					Specify the width of the card
+					Specify the width of the widget
 				
 
 				
 					height
-					Specify the height of the card
+					Specify the height of the widget
 				
 
 				
@@ -340,15 +340,15 @@ document.addEventListener('DOMContentLoaded', function() {
 	

 
 	

-		You can also dynamically create Steam Server cards via JavaScript:

+		You can also dynamically create Steam Server widgets via JavaScript:

 
 		
 			
-<div id="server-card"></div>
+<div id="server-widget"></div>
 
 <script>
 document.addEventListener('DOMContentLoaded', function() {
-    let card = new SteamServer('#server-card', {
+    let widget = new SteamServer('#server-widget', {
         addr: 'ip:port',
         //You can specify the same attributes as shown in the table above
     });
@@ -373,23 +373,23 @@ document.addEventListener('DOMContentLoaded', function() {
 				
 
 				
-					updateCard()
-					Updates the card data and displays them
+					updateWidget()
+					Updates the widget data and displays them
 				
 
 				
 					changeLang(bots, secure_yes, secure_no, hosting_dedicated, hosting_listen, playtext)
-					Changes the language of the card using the given information
+					Changes the language of the widget using the given information
 				
 
 				
 					setImageVisibility(visibility)
-					Sets the card image visibility
+					Sets the widget image visibility
 				
 
 				
 					remove()
-					Removes the card from the document
+					Removes the widget from the document
 				
 			
 		
@@ -404,7 +404,7 @@ document.addEventListener('DOMContentLoaded', function() {
 	
Steam User

 
 	

-		When referenced the required Steam User module, the minimum code to render a card is as follows:

+		When referenced the required Steam User module, the minimum code to render a widget is as follows:

 		
 			
 <steam-user steamid="id"></steam-user>
@@ -412,7 +412,7 @@ document.addEventListener('DOMContentLoaded', function() {
 		

 
 		


-		This renders the following card:

+		This renders the following widget:

 		
 	

 
@@ -437,7 +437,7 @@ document.addEventListener('DOMContentLoaded', function() {
 
 				
 					header
-					If you want to render the card with a header image you may specify the URL to an image here
+					If you want to render the widget with a header image you may specify the URL to an image here
 				
 
 				
@@ -462,12 +462,12 @@ document.addEventListener('DOMContentLoaded', function() {
 
 				
 					width
-					Specify the width of the card
+					Specify the width of the widget
 				
 
 				
 					height
-					Specify the height of the card
+					Specify the height of the widget
 				
 
 				
@@ -499,15 +499,15 @@ document.addEventListener('DOMContentLoaded', function() {
 	

 
 	

-		You can also dynamically create Steam User cards via JavaScript:

+		You can also dynamically create Steam User widgets via JavaScript:

 
 		
 			
-<div id="user-card"></div>
+<div id="user-widget"></div>
 
 <script>
 document.addEventListener('DOMContentLoaded', function() {
-    let card = new SteamUser('#user-card', {
+    let widget = new SteamUser('#user-widget', {
         steamid: 'id',
         //You can specify the same attributes as shown in the table above
     });
@@ -532,23 +532,23 @@ document.addEventListener('DOMContentLoaded', function() {
 				
 
 				
-					updateCard()
-					Updates the card data and displays them
+					updateWidget()
+					Updates the widget data and displays them
 				
 
 				
 					changeLang(online_yes, online_no, member_since, viewtext)
-					Changes the language of the card using the given information
+					Changes the language of the widget using the given information
 				
 
 				
 					setImageVisibility(visibility)
-					Sets the card image visibility
+					Sets the widget image visibility
 				
 
 				
 					remove()
-					Removes the card from the document
+					Removes the widget from the document