-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
71 lines (47 loc) · 2.83 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
=== Search Star Wars Stuff ===
Contributors: PatrickPelayo
Tags: star wars, search star, star, wars, darth vader
Requires at least: 5.5.3
Tested up to: 5.6.0
Stable tag: 1.2.0
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Search for information on Star Wars Characters,ships,vehicles,planets,species, and the films from episodes 1-6.
== Description ==
From episode 1-6 search information on Star Wars Characters,ships,vehicles,planets,species, and the films. Find information such as Luke's homeworld, Tatooine's population, cost of a Star-Destroyer in credits, and *more*.
= Instructions =
= Install =
The *plugin manager* is located on the *administration page*. From the *administration page* in the left side bar click *Plugins*. From the top of the page click *add new*.
Install the plugin thru the *plugin manager*, or upload it as a zip file into the *plugin manager*.
= Use =
There are two differant ways to use this plugin. It can be used in a *Sidebar* or placed directly into a post as a *Gutenberg Block Object*.
**SideBar**
* **Customize Menu**
From the main administration page in the left sidebar hover your mouse over *Appearance*. Click *Customize* and then click Widgets. Then click on the sidebar that you wish to add the widget to. Then click *Add a Widget*. Find *Search Star Wars* in the list and click it. Type a title and then click done.
* **Widget Menu**
From the main administration page in the left sidebar hover your mouse over *Appearance*. Click *Widgets* and then a list of available widgets will be displayed on the page. Find and click *Search Star Wars* and then select the sidebar that you would like to add the widget to. Type a title for it and then hit done.
**Gutenberg Block Object**
* **As a post**
Create a post like you normally would and then click the + icon displayed to *Add block*. Find *Search Star Wars* to add the widget to the post. Type a title for the widget and then save the post.
= Additional Info =
No service calls are made to obtain the data needed to use this plugin, but the data used to create the "starwarsData.json" file was originally obtained thru https://swapi.dev/, of which obtained the data from open sources such as wookieepedia.
== Screenshots ==
1. Example of widget before searching.
2. Example of widget when typing into search bar.
3. Example of a search result from the widget.
== Changelog ==
= 1.2 =
* Added the ability to apply the widget as a gutenberg block object and applied more responsiveness to the widget.
= 1.1 =
* updated the appearance of the plugin
= 1.0 =
* first release
== Upgrade Notice ==
= 1.2 =
* Upgrade if you want to use the widget in the body of a post or have the widget more responsive on the page.
= 1.1 =
* Provides a better apperance of the widget.
= 1.0 =
* first release
== Frequently Asked Questions ==