Christian Rocha
734aea5ee0
chore(README): various header improvements
...
* Update header image colors
* Link header to high-res mascot
* Add phorm badge
2024-03-18 22:09:05 -04:00
Reid Mason
49671292f7
fix: Corrected border shorthand functions explanation ( #237 )
2023-10-20 19:52:10 -04:00
Christian Rocha
b0605d31b2
docs: also link to table examples in the README
2023-10-12 07:30:51 -04:00
Maas Lalani
4476263d05
Feature: Tables ( #218 )
...
* feat: tables
* fix(table): examples
* docs(table): `any` -> `string`
* chore: go mod tidy
* docs(table): update image
* fix(table): lint
* fix: remove binary
* chore: color adjustments to pokemon example (#231 )
* fix(table): support rendering empty data sets
* chore(table): simplify table's data interface
* fix(table): correct GoDoc + add doc comments to Data methods
---------
Co-authored-by: Christian Rocha <christian@rocha.is>
Co-authored-by: Christian Muehlhaeuser <muesli@gmail.com>
2023-10-10 10:27:52 -04:00
Christian Rocha
b3bce2366a
chore(docs): add section about tab conversion ( #207 )
2023-07-24 12:42:34 -04:00
bashbunni
859b49e848
docs: add FAQ ( #189 )
...
* docs: add FAQ
* chore(docs): update encoding/locale answer in FAQ
* chore(docs): update color profile disclaimer
* chore(docs): faq copyedits
* chore(docs): additional faq copy edits
* fix(docs): add missing closing code block in faq
---------
Co-authored-by: Christian Rocha <christian@rocha.is>
2023-05-23 11:58:52 -07:00
Christian Rocha
19ca9a3f8c
docs: renderer documentation ( #175 )
...
* docs(readme): add some context to the examples
* docs(readme): revert to render-function-based initial example
* docs(readme): drop extraneous stringer usage
* docs(readme): copyedits
* docs(renderer): minor documentation improvements
* docs(readme): edit renderer section to focus on custom outputs
* docs(readme): for now just use SetString to illustrate stringer
* docs(readme): re-add Ayman's clever stringer example
* docs(examples): tidy up wish example
* docs(examples): improve wish example
* docs(examples): session is an io.Writer
Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
* docs(examples): add missing pty argument
Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
* docs(example): remove extra space
* fix(examples): use termenv output
---------
Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
2023-03-08 14:51:26 -05:00
Ayman Bagabas
5e2b9055dc
docs: update readme
2023-02-09 11:59:54 -05:00
Ayman Bagabas
abee24064a
docs: update readme example
2023-02-09 11:59:54 -05:00
Ayman Bagabas
6f6b47fbe3
docs: update readme
...
* add new color types
* more examples
* custom renderer example
2023-02-09 11:59:54 -05:00
Ayman Bagabas
31ab45f810
feat: instantiate lipgloss renderers
...
* Use lipgloss instances instead of a singleton global instance
* Deprecate (s Style).Render & (s Style).String
* Deprecate the Stringer interface
* Update README and godocs
* Update example
2023-02-09 11:59:54 -05:00
nervo
1c1240fd65
docs: fix various typos ( #156 )
2022-11-08 10:55:11 +01:00
Christian Muehlhaeuser
cdc8b16b07
docs: new readme footer
2022-10-24 10:18:43 +02:00
Christian Rocha
30dc6d9f2b
docs(readme): ASCII is an acronym
2022-09-30 07:22:31 +02:00
Christian Rocha
b10373fbc6
docs: add feedback section to README
2022-09-30 07:22:31 +02:00
Christian Rocha
b4057ad28a
docs: use new footer image
2022-09-30 07:22:31 +02:00
Stefan VanBuren
94046d357b
Fix README.md typo
2021-12-10 15:22:07 -05:00
Maas Lalani
87d191bbb7
doc: fix typos in README
2021-11-22 11:49:27 -05:00
Christian Rocha
639b1fe3b8
Correct stringer interface example in README
2021-06-16 12:56:04 -04:00
Christian Muehlhaeuser
40b2c31765
Fix README examples for joins
2021-06-16 03:46:47 +02:00
Christian Rocha
117c27dc45
Add SetColorProfile for explicitly setting the color profile
2021-05-31 12:47:39 -04:00
Christian Rocha
f5b1667a09
Adjust some instructional README copy
2021-04-29 09:59:44 -04:00
Christian Rocha
6064d52be1
Support for multi-rune borders
2021-04-29 09:59:44 -04:00
Christian Rocha
36f851c815
Add some border documentation to the README
2021-04-29 09:59:44 -04:00
Christian Rocha
493d49e38a
Add info on measuring width/height to README + add Size helper function
2021-04-29 09:59:44 -04:00
Christian Rocha
1e530f78cb
Split utility functions into their own section in the README
2021-04-29 09:59:44 -04:00
Ahmed Khalf
5874013ef4
Fix example code to reflect api changes
...
Added boolean to Inline() function
2021-04-05 17:43:36 -04:00
Christian Rocha
816cd12f4a
Remove irrelevant note about unset and falsey values
2021-04-05 15:20:51 -04:00
Christian Rocha
57eb90e4ca
Fix typo in README
2021-04-03 10:25:48 -04:00
Christian Muehlhaeuser
1ac779f6f5
Fix typo in README
2021-04-03 10:22:59 -04:00
Christian Rocha
975984b13e
Rework Bubble Tea section of README based on the release notes
2021-04-02 22:03:21 -04:00
Christian Rocha
f271740892
Add header art to README
2021-04-02 18:11:32 -04:00
Christian Rocha
31edf671ae
Correct align and join examples in the README + copy corrections
2021-03-31 14:06:12 -04:00
Christian Rocha
701d83b0e6
Fix an inconsistency in a README example
2021-03-31 11:00:36 -04:00
Christian Rocha
382505df54
Add example image to README + small README copy edits
2021-03-31 10:41:07 -04:00
Christian Rocha
31b52762a4
Style.Inline() now skips over padding, margins and borders entirely
2021-03-31 09:55:21 -04:00
Christian Rocha
247757451d
Clarify what unsetting means in the README
2021-03-30 23:00:40 -04:00
Christian Rocha
36d20119f8
Add note about Bubble Tea/Bubbles to the README
2021-03-30 22:56:22 -04:00
Christian Rocha
5f2462b486
Add info about Place/PlaceHorizontal/PlaceVertical to the README
2021-03-30 22:44:03 -04:00
Christian Rocha
7d217d8505
Add utils for measuring paragraphs
2021-03-29 17:45:42 -04:00
Christian Rocha
e260c72ca6
Adjust README copy about color conversion
2021-03-25 09:19:04 -04:00
Christian Rocha
7b5208a1cd
Add Height and MaxHeight properties
2021-03-24 14:42:45 -04:00
Christian Rocha
acd9df30a7
Change margin and padding APIs to closer match CSS
2021-03-24 13:55:43 -04:00
Christian Rocha
670f0d0d2d
Correct and extend join examples in README
2021-03-19 11:33:52 -04:00
Christian Rocha
ca0afc03da
Add join example and note about Glamour to README
2021-03-18 15:03:11 -04:00
Christian Rocha
52b15b9469
Further README corrections
2021-03-18 13:59:27 -04:00
Christian Rocha
52c837e21f
More README corrections and improvements
2021-03-18 13:29:03 -04:00
Christian Rocha
daf723aaa8
Add badges
2021-03-18 12:40:33 -04:00
Christian Rocha
2891ec0d5b
First pass at a README and user guide
2021-03-18 11:54:27 -04:00
