Commit Graph

39 Commits

Author SHA1 Message Date
Rishabh
0e3d918319 Updated readme
no refs

- updates local development section to add new mode
2021-11-02 10:56:10 +05:30
Rishabh
6f88adf4b4 Renamed master to main for test workflow and readme
no refs

The master -> main rename was missed for test workflows as well as Readme badge, which caused the error reporting to incorrectly report passing tests on `master` while they were failing on `main`
2021-05-27 17:52:32 +05:30
Rish
627b2238da Updated readme
no refs
2021-03-17 22:34:00 +05:30
John O'Nolan
14314613c0 2021 2021-01-25 16:35:55 +00:00
Rish
bf8d949a22 Renamed custom trigger classname to portal
no issue

Custom class is appended to trigger buttons based on popup state to allow UI changes based on different popup state. The class name is updated from using members terminology to new Portal terminology now.
2020-11-25 12:18:06 +05:30
Rish
aa6bb75e13 Updated readme usage section
no issue

Updates usage section to correctly highlight directly adding script or enabling via Ghost config setups
2020-10-14 14:24:24 +05:30
Rish
04cab22a5c Updated readme
no issue

- Updated badge and portal naming
2020-09-24 12:18:26 +05:30
Rish
d50c105000 Updated package name in readme 2020-09-24 12:02:17 +05:30
Rish
8db1b02558 Updated npm/unpkg name to portal
no issue

- Updates npm/unpkg name to portal from members-js
- Updates script name from `members.min.js` -> `portal.min.js`
2020-09-23 23:43:46 +05:30
Rish
81823f531b Updated github repo name to Portal
no issue

- Updated readme and package json to point to new repo name
2020-09-23 12:53:10 +05:30
Rish
db9ca1322e Updated usage script to include site attribute
no issue

- To correctly inject the members.js script to any theme, it needs to know the correct site URL to access Ghost APIs.
- `data-ghost` attribute is needed on the script to define the correct Site url
2020-09-04 17:19:37 +05:30
Rish
2e0a3d87ad Updated readme
no issue

- Updated readme to reflect correct custom data attribute
2020-07-08 10:26:14 +05:30
Rish
0d50b68596 Updated publish note in readme
no issue

- Removes redundant manual version update line as `yarn ship` shows a prompt
2020-06-06 20:18:23 +05:30
Rish
4689061d49 Added custom trigger button note to readme
no issue

- Adds note on how custom trigger button works for theme devs
2020-06-06 20:10:26 +05:30
Rish
98354e9de0 Updated script usage in readme to remove explicit init and adminUrl
refs https://github.com/TryGhost/members.js/issues/25

- No dependency on adminUrl anymore as endpoints exist on site url
- Members.js script is auto initialized, no need for explicit init in themes anymore
- No local .env values need to be set for development as script loads data from fixtures directly
2020-05-01 17:10:17 +05:30
Rish
9edb3d2e58 Reworded usage section in readme
Simple rewording to make usage section shorter and to point
2020-04-29 13:38:29 +05:30
Rish
f237a6ee37 Updated unpkg link in readme to use latest version
no issue

Instead of pinning to specific released version, we use `@latest` for picking the last released version automatically
2020-04-28 23:41:20 +05:30
Rish
7fee47b9a7 Added yarn ship for publishing to npm/unpkg
refs https://github.com/TryGhost/members.js/issues/5

We use `yarn ship` across all our packages for publishing new versions.
2020-04-28 23:38:24 +05:30
Rish
197070bcfe Updated readme
Added note about adding drop-in script in code injection footer in admin
2020-04-28 01:22:44 +05:30
Rish
e7e9ceab7d Updated readme
Removes comment about explicit need for admin url not ending in trailing slash, we handle trailing slash in code now.
2020-04-28 01:12:10 +05:30
Rish
61de34aac8 Updated readme
Fixed CI status badge
2020-04-27 11:53:18 +05:30
Rish
4565cfb646 Update readme
Bump unpkg version to 0.2.1
2020-04-23 21:21:09 +05:30
Rish
72b8a376c6 Updated readme
Updated unpkg link to point to correct version
2020-04-23 18:02:43 +05:30
Rish
1a97c7d161 Updated readme
Updated reference to admin url needed for initialization as api domain, same as used by other api clients.
2020-04-23 17:57:41 +05:30
Rish
c58f29f1a9 Updated readme to tag latest unpkg version in script
Unpkg recommends tagging exact version in the url to avoid redirects and faster load times. Also ensures the init script is in sync with the unpkg version being picked up in case of any changes.
2020-04-23 13:56:09 +05:30
Rish
2cf40fa6b8 Updated readme
Updated example admin url value for local setup
2020-04-23 12:59:26 +05:30
Rish
93a14eea2e Renamed script init method
refs https://github.com/TryGhost/members.js/issues/6

- Renames script initialization method from `initMembersJS` to simply `init`
- Updates readme
2020-04-23 12:51:51 +05:30
Rish
e7973cf37a Updated Readme
Fixed init method
2020-04-21 15:18:12 +05:30
Rish
e36b6a8ae5 Updated readme 2020-04-21 14:51:16 +05:30
Rish
c05f3916c0 Updated readme
Cleaned up usage instructions
2020-04-21 11:17:23 +05:30
Rish
5eaa243003 Updated readme
Updates admin url format for initialization
2020-04-20 23:37:44 +05:30
Rish
86340abdc7 Updated Readme
Added Usage section
2020-04-20 23:26:55 +05:30
Rish
0539c543a7 Updated Readme 2020-04-20 23:03:24 +05:30
Rish
88d8008bcf Updated Readme 2020-04-20 22:12:30 +05:30
Rish
8be660def0 Updated local dev env configuration
- Use local dev config only for development mode
- `.env.local` by default gets triggered for production builds as well, unlike `.env.development.local`
2020-04-13 13:09:15 +05:30
Hannah Wolfe
c3d13f2451 Added local dev env configuration
- call init by default if there's an env var for ADMIN_URL
- add an example local dev config
2020-04-10 17:41:16 +01:00
Rish
f761672e32 Updated Readme 2020-03-30 19:02:19 +05:30
Rish
1b91730c48 Initial commit 2020-03-24 18:37:38 +05:30
Rish
4ff29d2735 Initialize project using Create React App 2020-03-24 18:37:04 +05:30