Skip to content

Commit 1fd5778

Browse files
code-reaper08code-reaper08
committed
Added changed name and removed typos in readme, prettified the files.
1 parent cde9531 commit 1fd5778

File tree

1 file changed

+146
-133
lines changed

1 file changed

+146
-133
lines changed

‎README.md

Lines changed: 146 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# SpectreMan
2+
23
<div align="center">
34

45
<img src="https://user-images.githubusercontent.com/64256342/128370480-ce2bd62e-f599-4fd0-8e40-1391fe5ce250.gif" alt="spectreman logo" width="200px">
@@ -12,26 +13,25 @@
1213

1314
## SpectreCSS:
1415

15-
SpectreCSS is a minimalistic CSS-only framework, which caught my eye, when i was searching for a pure CSS framework, giving me more flexibility and customization ability. When doing SpectreCSS, I got an idea to accomodate all the possible abilities of SpectreCSS into a ST package. I think SpectreCSS by itself is easy and smart, this autocomplete pacakage will add to its simplicity by providing ready to use snippets at your disposal.
16-
16+
SpectreCSS is a minimalistic CSS-only framework, which caught my eye, when i was searching for a pure CSS framework, giving me more flexibility and customization ability. When doing SpectreCSS, I got an idea to accomodate all the possible abilities of SpectreCSS into a ST package. I think SpectreCSS by itself is easy and smart, this autocomplete package will add to its simplicity by providing ready to use snippets at your disposal.
1717

1818
## Installation:
19-
### Package Control ![recommended](https://img.shields.io/badge/method-recommended-blue "Use this")
2019

21-
The easiest way to install the MarkdownAssistant is by using [Package Control](https://packagecontrol.io/). Installing it [is documented here](https://packagecontrol.io/installation).
20+
### Package Control ![recommended](https://img.shields.io/badge/method-recommended-blue "Use this")
2221

22+
The easiest way to install the SpectreMan is by using [Package Control](https://packagecontrol.io/). Installing it [is documented here](https://packagecontrol.io/installation).
2323

2424
- Open Package Control (or hit Ctrl+Shift+P or Cmd+Shift+P)
2525
- Type _install_ and hit enter
26-
- Type MarkdownAssistant and hit enter again
26+
- Type SpectreMan and hit enter again
2727

2828
---
2929

3030
## Downloading the Archive
3131

32-
>Use this method if you don’t have Package Control or Git
32+
> Use this method if you don’t have Package Control or Git
3333
34-
- Open [https://github.com/code-reaper08/S](https://github.com/code-reaper08/S) in your browser
34+
- Open [https://github.com/code-reaper08/SpectreMan](https://github.com/code-reaper08/SpectreMan) in your browser
3535
- On the right hand side there is a _Download ZIP_ button – click it
3636
- Go to _Preferences_ and _Browse packages…_ which opens the Packages directory
3737
- Extract the archive inside the Packages directory
@@ -40,156 +40,169 @@ To find out where the Packages directory is, you can go to _Preferences_ and _Br
4040

4141
## Functions at your disposal:
4242

43-
### CDN
44-
Trigger word | function |
45-
| ------------- |:-------------:|
46-
| sp-cdn | CDN links |
43+
### CDN
44+
45+
| Trigger word | function |
46+
| ------------ | :-------: |
47+
| sp-cdn | CDN links |
48+
4749
### Typography functions
48-
| Trigger word | function |
49-
| ------------- |:-------------:|
50-
| sp-bq | blockquote |
51-
| sp-dl | descriptionlist |
52-
| sp-h1 | H1 heading |
53-
| sp-ol | orderedList |
54-
| sp-p | Paragraph |
55-
| sp-ul | UnoderedList|
50+
51+
| Trigger word | function |
52+
| ------------ | :-------------: |
53+
| sp-bq | blockquote |
54+
| sp-dl | descriptionlist |
55+
| sp-h1 | H1 heading |
56+
| sp-ol | orderedList |
57+
| sp-p | Paragraph |
58+
| sp-ul | UnoderedList |
5659

5760
### Table functions
58-
| Trigger word | function |
59-
| ------------- |:-------------:|
60-
| sp-table | default table |
61-
| sp-table-scroll | Scrollable table |
62-
| sp-table-s | Striped Table |
61+
62+
| Trigger word | function |
63+
| --------------- | :--------------: |
64+
| sp-table | default table |
65+
| sp-table-scroll | Scrollable table |
66+
| sp-table-s | Striped Table |
6367

6468
### Semantic functions
65-
| Trigger word | function |
66-
| ------------- |:-------------:|
67-
| sp-abbr | abbreviation |
68-
| sp-b | Bold |
69-
| sp-cite | Citation |
70-
| sp-code | Type-Code |
71-
| sp-del | Deleted text |
72-
| sp-em | Emphasis text |
73-
| sp-mark | Highlighted text |
74-
| sp-ins | Inserted text |
75-
| sp-it | Italics |
76-
| sp-kbd | KeyBindings |
77-
| sp-rby | Ruby(For East-Asian typography) |
78-
| sp-out | Sample output |
79-
| sp-strike | Strikethrough |
80-
| sp-sub | Subscripted text |
81-
| sp-sup | Superscripted text |
82-
| sp-time | Time |
83-
| sp-uline | Underlined text |
84-
| sp-var | Variables |
69+
70+
| Trigger word | function |
71+
| ------------ | :-----------------------------: |
72+
| sp-abbr | abbreviation |
73+
| sp-b | Bold |
74+
| sp-cite | Citation |
75+
| sp-code | Type-Code |
76+
| sp-del | Deleted text |
77+
| sp-em | Emphasis text |
78+
| sp-mark | Highlighted text |
79+
| sp-ins | Inserted text |
80+
| sp-it | Italics |
81+
| sp-kbd | KeyBindings |
82+
| sp-rby | Ruby(For East-Asian typography) |
83+
| sp-out | Sample output |
84+
| sp-strike | Strikethrough |
85+
| sp-sub | Subscripted text |
86+
| sp-sup | Superscripted text |
87+
| sp-time | Time |
88+
| sp-uline | Underlined text |
89+
| sp-var | Variables |
8590

8691
### Navbar function
87-
| Trigger word | function |
88-
| ------------- |:-------------:|
89-
| sp-nav | Navbar default |
92+
93+
| Trigger word | function |
94+
| ------------ | :------------: |
95+
| sp-nav | Navbar default |
9096

9197
### Media functions
92-
| Trigger word | function |
93-
| ------------- |:-------------:|
94-
| sp-cap | figcaption |
98+
99+
| Trigger word | function |
100+
| ------------ | :----------------: |
101+
| sp-cap | figcaption |
95102
| sp-i-con | Auto cropped Image |
96-
| sp-i-cov | Image covers |
97-
| sp-img | Responsive image |
98-
| sp-v | Responsive video |
103+
| sp-i-cov | Image covers |
104+
| sp-img | Responsive image |
105+
| sp-v | Responsive video |
99106

100107
### Layout functions
101-
| Trigger word | function |
102-
| ------------- |:-------------:|
103-
| sp-col-12 | Column 12 |
104-
| sp-col-9 | Column 9 |
105-
| sp-col-6 | Column 6 |
106-
| sp-col-3 | Column 3 |
108+
109+
| Trigger word | function |
110+
| ------------ | :-------: |
111+
| sp-col-12 | Column 12 |
112+
| sp-col-9 | Column 9 |
113+
| sp-col-6 | Column 6 |
114+
| sp-col-3 | Column 3 |
107115

108116
### Language functions
109-
| Trigger word | function |
110-
| ------------- |:-------------:|
111-
| sp-chs | chinese Simplified font support |
112-
| sp-cht | chinese traditional font support |
113-
| sp-j | japanese font support |
114-
| sp-ko | Korean font support |
117+
118+
| Trigger word | function |
119+
| ------------ | :------------------------------: |
120+
| sp-chs | chinese Simplified font support |
121+
| sp-cht | chinese traditional font support |
122+
| sp-j | japanese font support |
123+
| sp-ko | Korean font support |
115124

116125
### Lable functions
117-
| Trigger word | function |
118-
| ------------- |:-------------:|
119-
| sp-l | Label default |
120-
| sp-lerr | Label error |
121-
| sp-lp | Label primary |
122-
| sp-lsec |Label secondary |
123-
| sp-lsuc | Label success |
124-
| sp-lwarn | Label warning |
126+
127+
| Trigger word | function |
128+
| ------------ | :-------------: |
129+
| sp-l | Label default |
130+
| sp-lerr | Label error |
131+
| sp-lp | Label primary |
132+
| sp-lsec | Label secondary |
133+
| sp-lsuc | Label success |
134+
| sp-lwarn | Label warning |
125135

126136
### Form functions
127-
| Trigger word | function |
128-
| ------------- |:-------------:|
129-
| sp-fchk | Form checkbox |
130-
| sp-fcolor | Color input |
131-
| sp-fdate | Date input |
132-
| sp-femail | Email input |
133-
| sp-ffile | File input |
134-
| sp-fhor | Horizontal sample form |
135-
| sp-finp | Form input |
136-
| sp-fload | Input loading |
137-
| sp-fnum | Number input |
138-
| sp-fpass | Password input |
139-
| sp-fr | Radio input |
140-
| sp-fsearch | Search input |
141-
| sp-fs | Form select |
142-
| sp-fswitch | Form switch |
143-
| sp-ftel | Telephone input |
144-
| sp-ftxt | Text area |
145-
| sp-furl | URL input |
137+
138+
| Trigger word | function |
139+
| ------------ | :--------------------: |
140+
| sp-fchk | Form checkbox |
141+
| sp-fcolor | Color input |
142+
| sp-fdate | Date input |
143+
| sp-femail | Email input |
144+
| sp-ffile | File input |
145+
| sp-fhor | Horizontal sample form |
146+
| sp-finp | Form input |
147+
| sp-fload | Input loading |
148+
| sp-fnum | Number input |
149+
| sp-fpass | Password input |
150+
| sp-fr | Radio input |
151+
| sp-fsearch | Search input |
152+
| sp-fs | Form select |
153+
| sp-fswitch | Form switch |
154+
| sp-ftel | Telephone input |
155+
| sp-ftxt | Text area |
156+
| sp-furl | URL input |
146157

147158
### Component functions
148-
| Trigger word | function |
149-
| ------------- |:-------------:|
150-
| sp-acc | accordian |
151-
| sp-ava | Avatar |
152-
| sp-bdg | Badge default |
153-
| sp-bdg-btn | Badge with button |
154-
| sp-bc | Breadcrumbs |
155-
| sp-card | Card default |
156-
| sp-chips | Chips default |
157-
| sp-empty | Empty state |
158-
| sp-mod | Modal box |
159-
| sp-nav | Nav |
160-
| sp-pg1 | Pagination with pg_no |
161-
| sp-pg2 | Pagination prev-next type |
162-
| sp-pnl | panel |
163-
| sp-bpop | Bottom popover |
164-
| sp-lpop | Left popover |
165-
| sp-rpop | Right popover |
166-
| sp-tpop | Top popover |
167-
| sp-sl-t | Slider with tool tip |
168-
| sp-sl | Slider default |
169-
| sp-stp | Steps |
170-
| sp-tile1 | Tiles type1 |
171-
| sp-ftile | File tile |
172-
| sp-tt | Tooltip |
159+
160+
| Trigger word | function |
161+
| ------------ | :-----------------------: |
162+
| sp-acc | accordian |
163+
| sp-ava | Avatar |
164+
| sp-bdg | Badge default |
165+
| sp-bdg-btn | Badge with button |
166+
| sp-bc | Breadcrumbs |
167+
| sp-card | Card default |
168+
| sp-chips | Chips default |
169+
| sp-empty | Empty state |
170+
| sp-mod | Modal box |
171+
| sp-nav | Nav |
172+
| sp-pg1 | Pagination with pg_no |
173+
| sp-pg2 | Pagination prev-next type |
174+
| sp-pnl | panel |
175+
| sp-bpop | Bottom popover |
176+
| sp-lpop | Left popover |
177+
| sp-rpop | Right popover |
178+
| sp-tpop | Top popover |
179+
| sp-sl-t | Slider with tool tip |
180+
| sp-sl | Slider default |
181+
| sp-stp | Steps |
182+
| sp-tile1 | Tiles type1 |
183+
| sp-ftile | File tile |
184+
| sp-tt | Tooltip |
173185

174186
### Code function
175-
| Trigger word | function |
176-
| ------------- |:-------------:|
177-
| sp-codem | Code snippet |
187+
188+
| Trigger word | function |
189+
| ------------ | :----------: |
190+
| sp-codem | Code snippet |
178191

179192
### Button functions
180-
| Trigger word | function |
181-
| ------------- |:-------------:|
182-
| sp-btn-menu | Menu Action button |
183-
| sp-btn-menu-c | Menu Action Round button |
184-
| sp-btn | Button default |
185-
| sp-btn-dis | Disabled button |
186-
| sp-btn-e | Error button (red) |
187-
| sp-btn-grp | Button group |
188-
| sp-btn-lnk |Link button |
189-
| sp-btn-load | Loading button |
190-
| sp-btn-p | Primary button |
191-
| sp-btn-s | Success button (green) |
192193

194+
| Trigger word | function |
195+
| ------------- | :----------------------: |
196+
| sp-btn-menu | Menu Action button |
197+
| sp-btn-menu-c | Menu Action Round button |
198+
| sp-btn | Button default |
199+
| sp-btn-dis | Disabled button |
200+
| sp-btn-e | Error button (red) |
201+
| sp-btn-grp | Button group |
202+
| sp-btn-lnk | Link button |
203+
| sp-btn-load | Loading button |
204+
| sp-btn-p | Primary button |
205+
| sp-btn-s | Success button (green) |
193206

194207
## License:
195208

@@ -215,4 +228,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
215228
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
216229
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
217230
SOFTWARE.
218-
```
231+
```

0 commit comments

Comments
 (0)